Get Robot Schedule List

POST: /robot/schedule/list

This method returns, for the specified date range, a list of:

  • Robots already executed,
  • Robots being executed, either in status queued or running, and
  • Robot schedules, in case of executions planned for the future.

The input field dateRange is required.

Input parameters

The field "dateRange" refers to "schedule time". Schedule time indicates when the robot will be launched.

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 null Schedule's Id. The value is null when execution is launched.
scheduleInstructionText null Schedule instructions
scheduleDescription null Schedule description. The value is null when execution is launched.
robotId robot-test Id of robotic process
robotName 1542807935990 Name of robotic process
nodeId 5daf2144a06eabc8d4ffcee8 Id of resource
nodeName node-test Name of resource
scheduleTime 1571746484000 Date and time the robotic process is scheduled to launch
startTime 1571746101555 Date and time when the robotic process started
endTime 1571746901555 Date and time when the robotic process ended
status COMPLETED Status of the execution. Possible values are: COMPLETED, ENQUEUED, RUNNING, SCHEDULED, or SCHEDULED_DISABLED

Possible reasons for unsuccessful events

(if "invocationResult" is "KO")

None


This version of the Appian RPA documentation was written for Appian 20.4, and does not represent the interfaces or functionality of other Appian versions.
Open in Github Built: Fri, Oct 15, 2021 (09:55:45 AM)

On This Page

FEEDBACK