Get Queue List

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

Get Queue List

POST: /queue/list

This method returns the list of queues that were updated during the specified date range.

Request body

Parameter Example Required? Description
dateRange.start 1461457843868 Yes Defines the start date for the range, expressed in UNIX epoch time
Units: milliseconds
dateRange.end 1561457843866 Yes Defines the end date for the range, 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 elements are provided in the result.queues key.

Element Example Data type Description
id "1" String Id of the queue
name "Test queue" String Name of the queue
status "PENDING" String Queue status. Possible values are: PENDING, IN_PROCESS, FINISHED, RESERVED, CLOSED
lastUpdatedTimestamp 1542807938000 String Date and time the queue was last updated, expressed in UNIX epoch time
Units: milliseconds
createdTimestamp 1542807935990 String Date and time the queue was created, expressed in UNIX epoch time
Units: milliseconds

Example response body:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
{
    "invocationResult": "OK",
    "result": {
        "lastUpdated": 1627660315550,
        "errorMessage": null,
        "queues": [
            {
                "id": "1",
                "name": "Inventory",
                "status": "PENDING",
                "lastUpdatedTimestamp": 1627660254000,
                "createdTimestamp": 1627660254421
            }
        ]
    },
    "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