Add workbook schedule

POST

/v2/workbooks/:workbookId/schedules

POST

/v2/workbooks/:workbookId/schedules

$ curl -X POST https://api.sigmacomputing.com/v2/workbooks/workbookId/schedules \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "target": [
>     {}
>   ],
>   "schedule": {
>     "cronSpec": "string",
>     "timezone": "string"
>   }
> }'

200Successful

1 {
2   "scheduledNotificationId": "string",
3   "workbookId": "string",
4   "schedule": {
5     "cronSpec": "string",
6     "timezone": "string"
7   },
8   "configV2": {
9     "title": "string",
10     "messageBody": "string",
11     "notificationAttachments": [
12       {
13         "formatOptions": {
14           "type": "CSV"
15         },
16         "chartId": "string",
17         "workbookExportSource": {
18           "elementId": "string",
19           "type": "element"
20         }
21       }
22     ],
23     "includeLink": true,
24     "runAsRecipient": true,
25     "attachmentSettings": {
26       "mergePdfAttachments": true,
27       "zipAttachments": true
28     },
29     "conditionOptions": {
30       "type": "always"
31     },
32     "alertConfig": {
33       "window": "alltime",
34       "volume": 1.1
35     },
36     "notificationName": "string",
37     "dashboardSettings": {
38       "filters": [
39         {
40           "id": "string",
41           "filterStr": "string"
42         }
43       ],
44       "variableValues": {}
45     },
46     "dynamicExportSettings": {
47       "variables": {}
48     },
49     "dynamicRecipientSettings": {
50       "sourceNodeId": "string",
51       "recipientColumnId": "string"
52     },
53     "rowLimit": 1.1,
54     "workbookVariant": {
55       "tagId": "string",
56       "exploreKey": "string",
57       "bookmarkId": "string"
58     },
59     "embedOpts": {
60       "embedId": "string",
61       "evalConnectionId": "string"
62     },
63     "formatting": {
64       "pivotHeaderStyle": "merged"
65     }
66   },
67   "isSuspended": true,
68   "ownerId": "string",
69   "lastUpdatedByUser": "string",
70   "disabledAt": "2024-01-15T09:30:00Z",
71   "disabledBy": "string",
72   "createdBy": "string",
73   "updatedBy": "string",
74   "createdAt": "2024-01-15T09:30:00Z",
75   "updatedAt": "2024-01-15T09:30:00Z"
76 }

Add a schedule to a workbook to export data from the workbook on a periodic basis.

Usage notes

Retrieve the workbookId by calling the /v2/workbooks endpoint.
Retrieve relevant IDs based on the export contents and destination:
- To export to one or more Sigma users, retrieve the memberId by calling the /v2/members endpoint.
- To export to one or more Sigma teams, retrieve the teamId by calling the /v2/teams endpoint.
Retrieve the pageId by calling the /v2/workbooks/{workbookId}/pages endpoint.
Retrieve the elementId by first calling the /v2/workbooks/{workbookId}/pages endpoint, then calling the /v2/workbooks/{workbookId}/pages/{pageId}/elements endpoint.

Add a schedule to a workbook to export data from the workbook on a periodic basis. ### Usage notes - Retrieve the **workbookId** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint. - Retrieve relevant IDs based on the export contents and destination: - To export to one or more Sigma users, retrieve the **memberId** by calling the [/v2/members](https://help.sigmacomputing.com/reference/list-members) endpoint. - To export to one or more Sigma teams, retrieve the **teamId** by calling the [/v2/teams](https://help.sigmacomputing.com/reference/list-teams) endpoint. - Retrieve the **pageId** by calling the [/v2/workbooks/{workbookId}/pages](https://help.sigmacomputing.com/reference/list-workbook-pages) endpoint. - Retrieve the **elementId** by first calling the [/v2/workbooks/{workbookId}/pages](https://help.sigmacomputing.com/reference/list-workbook-pages) endpoint, then calling the [/v2/workbooks/{workbookId}/pages/{pageId}/elements](https://help.sigmacomputing.com/reference/list-workbook-page-elements) endpoint.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

workbookIdstringRequired

Request

The request body.

targetlist of objectsRequired

One or more targets to send the workbook to.

scheduleobjectRequired

When to send the workbook export.

configV2objectOptional

Configuration settings for the export schedule.

configobjectOptional

[Deprecated] Configuration settings for the export.

descriptionstring or nullOptional

Description of the scheduled export

ownerIdstringOptional

ID of the user (member) to own the export.

Response

The response body.

scheduledNotificationIdstring

Unique identifier of the scheduled export.

workbookIdstring

Unique identifier of the workbook.

scheduleobject

configV2object

isSuspendedboolean

Whether the schedule is currently suspended.

ownerIdstring

Unique identifier of the user who owns the schedule.

lastUpdatedByUserstring

Unique identifier of the user who last updated the schedule.

disabledAtdatetime or null

Timestamp when the schedule was disabled, or null if the schedule is active.

disabledBystring or null

Unique identifier of the member who disabled the schedule, or null if the schedule is active.

createdBystring

The identifier of the user who created this object.

updatedBystring

The identifier of the user or process that last updated this object.

createdAtdatetime

When the object was created.

updatedAtdatetime

When the object was last updated.