Get Robot Schedule Instructions

POST: /robot/schedule/instructions

This method returns, for the specified date range, a list of the schedule instructions The input field dateRange is required.

Input parameters

The field "dateRange" refers to "last updated". Last updated date indicates when the schedule instructions were updated.

Parameter Example Comments
dateRange.start 1461457843868 Date and time expressed in UNIX epoch time (milliseconds). Required field.
dateRange.end 1561457843866 Date and time expressed in UNIX epoch time (milliseconds). Required field.

Output (if "invocationResult" is "OK")

The following attributes are provided in the result.scheduleExecutionList key.

Attribute Example Comments
scheduleId "5cad9c28a3ac17ff159d35b0" Schedule's Id. The value is null when execution is launched.
scheduleDescription "queue" Schedule description. The value is null when execution is launched.
scheduleInstructionText At 3:05 AM, only on Tuesday (0 5 3 * * TUE) Schedule instructions
scheduleInstruction 0 5 3 * * TUE Schedule details - see below for formatting example
robotId "5dcd86ed17d0b602a53ce2d1" Id of robotic process
robotName "robot-tutorial" Name of robotic process
lastUpdatedTimestamp 1542807938000 Date and time the schedule was last updated, expressed in Java epoch time (milliseconds)
status ENABLED Status of the scheduled execution

The format for scheduleInstruction field 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

Possible reasons for unsuccessful events (if "invocationResult" is "KO")

None

Open in Github

On This Page

FEEDBACK