| 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: /node/list
Gets the status of all the robots for a specific time.
This endpoint accepts no request parameters. You must add an empty JSON ({}) to the raw request to receive a response.
The call is successful if "invocationResult" = "OK".
The following elements are provided in the result.nodes key.
| Element | Example | Data type | Description |
|---|---|---|---|
name |
"abbyy-planet#1" | String | Internal name of the robot |
id |
"5da9a68106931e0e1d1246b6" | String | Unique id of the robot |
customName |
"robot 1" | String | Human readable name for the robot |
labels |
"linux" | String | Permission tags assigned to the robot |
lastIp |
"127.0.1.1" | String | Last IP from agent connection |
connected |
true | String | Indicates whether or not the robot is connected |
lastAliveTime |
1569499279778 | String | Timestamp of the last communication received, expressed in UNIX epoch time Units: milliseconds |
plugged |
false | String | Indicates whether or not the robot is enabled |
monitored |
false | String | Indicates whether or not the robot is monitored |
paused |
false | String | Indicates whether or not the robot is paused |
controlled |
false | String | Indicates whether or not the robot is controlled by Remote Viewer |
endContract |
true | String | - |
upgradeAvailable |
true | String | Indicates whether or not there's an upgrade available in the console |
running |
Robot-name + number | String | Identifier of the current execution on the robot |
status |
offline | String | Indicates what the robot is currently doing. See the Robots page for a complete list of possible values. |
autoLoginEnabled |
true | String | Indicates whether or not the automatic login capability is enabled |
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
{
"invocationResult": "OK",
"result": {
"lastUpdated": 1627659206897,
"errorMessage": null,
"nodes": [
{
"id": "61040059e4b0c8349a1c3364",
"name": "61040059e4b0c8349a1c3363#1",
"customName": "Test Robot",
"labels": [
"roleoperation"
],
"lastIp": "10.34.12.119",
"connected": true,
"lastAliveTime": 1627659206247,
"plugged": true,
"monitored": false,
"paused": false,
"controlled": false,
"endContract": false,
"upgradeAvailable": false,
"running": null
"status": "offline",
"autoLoginEnabled": true
}
]
},
"exceptionThrownText": null
}
Possible reasons calls may be unsuccessful ("invocationResult" = "KO"):
To write the body of the response in a SAIL expression editor, wrap the input in quotation marks: " { } ".
Get Robot List
