The capabilities described on this page are included in Appian's standard capability tier. Usage limits may apply. |
Tip: Remember to include the appropriate authentication headers in your HTTP request message when using this method.
POST: /robot/schedule/instructions
This method returns a list of the schedule instructions for the specified date range.
The dateRange
field refers to when the schedule instructions were last updated.
Parameter | Example | Required? | Description |
---|---|---|---|
dateRange.start |
1461457843868 | Yes | Date and time expressed in UNIX epoch time Units: milliseconds |
dateRange.end |
1561457843866 | Yes | Date and time expressed in UNIX epoch time Units: milliseconds |
pageSize |
50 | No | The number of entries to return on each page of results. Acceptable values are between 1 and 250. 250 is the default. |
Example request body:
1
2
3
4
5
6
7
{
"dateRange": {
"start" : 1622505600000,
"end" : 1625097599000
},
"pageSize": 50
}
The call is successful if "invocationResult" = "OK".
The nextPageToken
property is a token used to retrieve the next page of results. To use it, append the nextPageToken
key and value to your original request body. The token is valid for 10 minutes and the response keeps generating a new nextPageToken
as long as there are more results to retrieve. Each subsequent request should use the nextPageToken
sent back in the previous response. When nextPageToken
is null in the response, the current page is the last one and there are no more entries to retrieve.
The following elements are provided in the result.scheduleExecutionList
key.
Element | Example | Data type | Description |
---|---|---|---|
scheduleId |
"5cad9c28a3ac17ff159d35b0" | String | Schedule's Id. The value is null when execution is launched. |
scheduleDescription |
"queue" | String | Schedule description. The value is null when execution is launched. |
scheduleInstructionText |
At 3:05 AM, only on Tuesday (0 5 3 * * TUE) | String | Schedule instructions |
scheduleInstruction |
0 5 3 * * TUE | Schedule details - see below for formatting example | |
robotId |
"5dcd86ed17d0b602a53ce2d1" | String | Id of robotic task |
robotName |
"robot-tutorial" | String | Name of robotic task |
lastUpdatedTimestamp |
1542807938000 | String | Date and time the schedule was last updated, expressed in UNIX epoch time Units: milliseconds |
status |
ENABLED | String | Status of the scheduled execution |
The format for scheduleInstruction
attribute is:
Second | Minute | Hour | Day of Month | Month | Day of Week |
---|---|---|---|---|---|
(0-59) | (0-59) | (0-23) | (1-31) | (1-12 or Jan-Dec) | (0-6 or Sun-Sat) |
0 | 5 | 3 | * | * | TUE |
Each column can contain a list of values separated by commas. Example:
At 04, 06, 08, 10, 12 and 14 minutes past the hour, at 9:00 AM and 11:00 AM, only on Monday, Wednesday and Friday (0 4,6,8,10,12,14 9,11 * * MON,WED,FRI)
Second | Minute | Hour | Day of Month | Month | Day of Week |
---|---|---|---|---|---|
(0-59) | (0-59) | (0-23) | (1-31) | (1-12 or Jan-Dec) | (0-6 or Sun-Sat) |
0 | 4,6,8,10,12,14 | 9,11 | * | * | MON,WED,FRI |
Example response body:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
{
"invocationResult": "OK",
"result": {
"lastUpdated": 1627659885431,
"errorMessage": null,
"nextPageToken": null,
"scheduleExecutionList": [
{
"scheduleId": "1",
"scheduleDescription": "Get the Appian stock price every weekday, twice a day",
"scheduleInstructionText": "At 10:00 AM and 3:00 PM, only on Monday, Tuesday, Wednesday, Thursday and Friday (0 0 10,15 * * MON,TUE,WED,THU,FRI)",
"scheduleInstruction": "0 0 10,15 * * MON,TUE,WED,THU,FRI",
"robotId": "5efb1872f9e21a2764d22396",
"robotName": "61040365e4b0c8349a1c3366",
"robotCustomName": "APPN-Stock-Price",
"lastUpdatedTimestamp": 1627659645000,
"status": "ENABLED"
}
]
},
"exceptionThrownText": null
}
Possible reasons calls may be unsuccessful ("invocationResult" = "KO"):
Get Robotic Task Schedule Instructions