Free cookie consent management tool by TermsFeed Get Robotic Task Schedule List [Appian RPA v9.12]
Page not found in the selected version; redirected to the home page.
Get Robotic Task Schedule List
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.

Get robotic task schedule list

POST: /robot/schedule/list

For the specified date range, this endpoint returns a list of:

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

Request body

dateRange refers to the scheduled time. Schedule time indicates when the robotic task will be launched.

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

Example request body:

1
2
3
4
5
6

{
    "dateRange": {
            "start" : 1622505600000,
            "end" : 1625097599000
    }
}

Response

The call is successful if "invocationResult" = "OK".

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

Element Example Data type Description
scheduleId null String Schedule's Id. The value is null when execution is launched.
scheduleInstructionText null String Schedule instructions
scheduleDescription null String Schedule description. The value is null when execution is launched.
robotId "robot-test" String Id of robotic task
robotName "1542807935990" String Name of robotic task
nodeId "5daf2144a06eabc8d4ffcee8" String Id of robot
nodeName "node-test" String Name of robot
scheduleTime 1571746484000 String Date and time the robotic task is scheduled to execute, expressed in UNIX epoch time
Units: milliseconds
startTime 1571746101555 String Date and time the execution started, expressed in UNIX epoch time
Units: milliseconds
endTime 1571746901555 String Date and time the execution ended, expressed in UNIX epoch time
Units: milliseconds
status "COMPLETED" String Status of the execution. Possible values are: COMPLETED, ENQUEUED, RUNNING, SCHEDULED, or SCHEDULED_DISABLED

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
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56

{
    "invocationResult": "OK",
    "result": {
        "lastUpdated": 1627659848997,
        "errorMessage": null,
        "nextPageToken": null,
        "scheduleExecutionList": [
            {
                "scheduleId": null,
                "scheduleDescription": null,
                "scheduleInstructionText": null,
                "robotId": "5efb1872f9e21a2764d22396",
                "robotName": "61040365e4b0c8349a1c3366",
                "robotCustomName": "APPN-Stock-Price",
                "nodeId": "61040059e4b0c8349a1c3364",
                "nodeName": "61040059e4b0c8349a1c3363#1",
                "nodeCustomName": "Windows Resource",
                "scheduleTime": 1627653060711,
                "startTime": 1627653163249,
                "endTime": 1627653164759,
                "status": "COMPLETED"
            },
            {
                "scheduleId": null,
                "scheduleDescription": null,
                "scheduleInstructionText": null,
                "robotId": "5efb1872f9e21a2764d22396",
                "robotName": "61040365e4b0c8349a1c3366",
                "robotCustomName": "APPN-Stock-Price",
                "nodeId": "61040059e4b0c8349a1c3364",
                "nodeName": "61040059e4b0c8349a1c3363#1",
                "nodeCustomName": "Windows Resource",
                "scheduleTime": 1627653106294,
                "startTime": 1627653171354,
                "endTime": 1627653172124,
                "status": "COMPLETED"
            },
            {
                "scheduleId": null,
                "scheduleDescription": null,
                "scheduleInstructionText": null,
                "robotId": "5efb1872f9e21a2764d22396",
                "robotName": "61040365e4b0c8349a1c3366",
                "robotCustomName": "APPN-Stock-Price",
                "nodeId": "61040059e4b0c8349a1c3364",
                "nodeName": "61040059e4b0c8349a1c3363#1",
                "nodeCustomName": "Windows Resource",
                "scheduleTime": 1627654853314,
                "startTime": 1627654860738,
                "endTime": 1627654870006,
                "status": "COMPLETED"
            }
        ]
    },
    "exceptionThrownText": null
}

Troubleshooting

Possible reasons calls may be unsuccessful ("invocationResult" = "KO"):

  • None

Get Robotic Task Schedule List

FEEDBACK