Get Resource List

Remember to include the appropriate authentication headers in your HTTP request message when using this method.

Get Resource List

POST: /node/list

Gets the status of all the resources for a specific time.

Request body

This endpoint accepts no request parameters. You may have to add an empty JSON ({}) to the raw request to receive a response.

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 resource
id "5da9a68106931e0e1d1246b6" String Unique id of the resource
customName "Resource 1" String Human readable name for the resource
labels "linux" String Permission tags assigned to the resource
lastIp "127.0.1.1" String Last IP from agent connection
connected true String Indicates if the resource is connected or not
lastAliveTime 1569499279778 String Timestamp of the last communication received, expressed in UNIX epoch time
Units: milliseconds
plugged false String Indicates if the resource is plugged or not
monitored false String Indicates if the resource is monitored or not
paused false String Indicates if the resource is paused or not
controlled false String Indicates if the resource is controlled by Remote Viewer
endContract true String -
upgradeAvailable true String Indicates if there's an upgrade available in the console
running Robot-name + number String Identifier of the current execution on the resource

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
{
    "invocationResult": "OK",
    "result": {
        "lastUpdated": 1627659206897,
        "errorMessage": null,
        "nodes": [
            {
                "id": "61040059e4b0c8349a1c3364",
                "name": "61040059e4b0c8349a1c3363#1",
                "customName": "Test Resource",
                "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
            }
        ]
    },
    "exceptionThrownText": null
}

Troubleshooting

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

  • None

This version of the Appian RPA documentation was written for Appian 21.4, and does not represent the interfaces or functionality of other Appian versions.
Open in Github Built: Fri, Dec 03, 2021 (02:38:50 PM)

On This Page

FEEDBACK