Associate Schedule

LLM-friendly URL
POST
https://api.luzmo.com/0.1.0/schedule
API call form
Examples

A schedule is an automated task that controls one of the following:

  • an alert for a chart on a dashboard

  • an export of a dashboard or a chart

  • a synchronization of a dataset, either as a Warp acceleration sync or as a sync of a webservice based dataset (like Google Drive, Asana or others)

Schedules are automatically associated to users upon creation (this association cannot be created manually) and need to then be associated to a dashboard or dataset in order to take effect.

While export and dataset schedules can be created, updated and deleted by all users or group members with at least modifying rights to the securable, in the case of alerts, schedules are automatically associated with the creating user and can only be updated and deleted by that user.

Parameters
Expand all Reset
id *UUIDrequired

The unique identifier of the entity

resource *OBJECTrequired
role *ENUMrequired
id *UUIDrequired
Can be executed by:
Entity Modifier
Can be associated to:
Alert
Dashboard
Dataset
User
Delete Schedule
Dissociate Schedule
Did this page help you?
Yes No
Language
Shell
Node
Java
.NET
Python
PHP
Install
npm install @luzmo/nodejs-sdk
Example Request 
import Luzmo from '@luzmo/nodejs-sdk';
const client = new Luzmo({
  api_key: '<your Luzmo API key>',
  api_token: '<your Luzmo API token>',
  host: 'https://api.luzmo.com'
});

const response = await client.associate('schedule',
  '<your entity id>',
  { role: '<the resource>', id: '<the resource id>' }
);
You are not authenticated.
Log in to try
Example Response
200
400
500
{
  "id": "29db3c0e-be2b-488b-9b54-d1d9ae9dff3a",
  "task": null,
  "started_at": "2018-09-03T12:38:18.614Z",
  "frequency": 1440,
  "retries": 0,
  "active": true,
  "completed_at": "2018-09-03T12:38:18.614Z",
  "created_at": "2018-09-03T12:38:18.630Z",
  "updated_at": "2018-09-03T12:38:18.656Z",
  "last_scheduled_at": null,
  "user_id": "b0d76f5d-f3da-4c55-9497-d8457ccdccda",
  "securable_id": "b3cfbfc2-a9c0-48e3-b726-b93bdb569bfa",
  "scheduled_at": "2018-09-04T12:38:18.614Z",
  "timezone": "Europe/Brussels"
}