Get Queue Items 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 queue items list

POST: /queue/items

This method returns the list of items from a queue, specified either by queueId or queueName. If no queueId or queueName are specified, it returns all items in all queues the user has access to. If both queueId and queueName are set, queueId is used.

If a date range is specified, the items to return must meet the following conditions:

The item must have already been processed
The item must have been last updated during the specified range

Request body

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
`queueId`	"5cf8ec2adeac351a6604fd71"	No	Optional queue id to search for
`queueName`	"queue with files"	No	Optional queue name to search for
`pageSize`	50	No	The number of entries to return on each page of results. Acceptable values are between 1 and 250. 250 is the default.

Example request body:

{
    "dateRange" : {
            "start" : 1622505600000,
            "end" : 1625097599000
    },
    "queueId" : "5cf8ec2adeac351a6604fd71",
    "queueName" : "queue with files",
    "pageSize" : 50
}

Response

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

The nextPageToken property is a token used to retrieve the next page of results. To use it, append the nextPageToken key and value to your original request body. The token is valid for 10 minutes and the response keeps generating a new nextPageToken as long as there are more results to retrieve. Each subsequent request should use the nextPageToken sent back in the previous response. When nextPageToken is null in the response, the current page is the last one and there are no more entries to retrieve.

The following elements are provided in the result.items key.

Element	Example	Data type	Description
`id`	5cf8ec61deac351a6604fd74	String	Internal id of the queue item
`key`	key number 3	Integer	Key
`queueId`	5cf8ec2adeac351a6604fd71	String	Queue id to which the item belongs
`queueName`	queue with files	String	Queue name to which the item belongs
`reference`	null	Array	-
`reference.state`	PENDING	String	Item's state. Possible values are DISABLED, PENDING, IN_PROCESS, FINISHED_OK, FINISHED_WARN
`duration`	3334	String	The length of time it took to process the item Units: milliseconds
`lastExecutionResult`	-	Array	Array of data including details about the robotic task to last execute the queue and item, described below.
`lastExecutionResult.id`	null	Integer	Internal id for the executed robotic task
`lastExecutionResult.robotName`	"5e4a72abe18edacba723b298"	String	Robotic task name, immutable since creation
`lastExecutionResult.robotCustomName`	"robot-developmentguide-queues-search"	String	Robotic task human-readable name
`lastExecutionResult.robotId`	"5e4a72abe18edacba723b299"	String	Unique id for the executed robotic task
`lastExecutionResult.executionNumber`	1	Integer	Execution number
`lastExecutionResult.executionId`	"3"	Integer	Execution id
`lastExecutionResult.itemIndex`	2	Integer	Item index in this execution
`lastExecutionResult.itemKey`	"jidoka"	String	Item key
`lastExecutionResult.itemResult`	"OK"	String	Result
`lastExecutionResult.itemSubResult`	null	String	Sub-result
`lastExecutionResult.itemSubResultText`	null	String	Sub-result in text format
`lastExecutionResult.itemResultDetail`	"jidoka"	String	Result details in text format
`lastExecutionResult.properties`	"Time required": "0.33", "Number of results":"315000"	Map	Map of properties associated with the execution
`lastExecutionResult.currentTimeMillis`	1586870440301	String	Time the queue item was processed, expressed in UNIX epoch time
`lastExecutionResult.duration`	3334	String	Duration in milliseconds
`lastExecutionResult.testing`	false	String	Boolean indicating whether this execution was a test
`remainingAttempts`	4	Integer	Number of remaining attempts
`priority`	NORMAL	String	Queue priority, possible values are HIGHEST, HIGHER, HIGH, NORMAL, LOW, LOWER, and LOWEST
`executionResults`	"5cf8eef7deac351a6604fdcd", "5cf8ee7edeac351a6604fdbb"	Array	List of executions where this queue item was processed
`functionalData`	"b": "yellow"	Map	Functional data associated with the queue item
`labels`	"roleoperation"	String	Permission tags for this queue item
`lastUpdatedTimestamp`	1561457843866	String	Date expressed in UNIX epoch time (milliseconds)
`createdTimestamp`	1461457843868	String	Date expressed in UNIX epoch time (milliseconds)
`lastNodeName`	Machine 1	String	Name of the robot where the last execution occurred
`lastNodeId`	5cf8ee2cdeac351a6604e01	String	ID of the robot where the last execution occurred

Example response body:

{
   "invocationResult":"OK",
   "result":{
      "lastUpdated":1627668581125,
      "errorMessage":null,
      "nextPageToken":null,
      "items":[
         {
            "id":"5cf8ec61deac351a6604fd74",
            "key":"key number 3",
            "queueId":"5cf8ec2adeac351a6604fd71",
            "queueName":"queue with files",
            "reference":[
               {
                  "state":"PENDING"
               }
            ],
            "duration":3334,
            "lastExecutionResult":[
               {
                  "id":null,
                  "robotName":"5e4a72abe18edacba723b298",
                  "robotCustomName":"robot-developmentguide-queues-search",
                  "robotId":"5e4a72abe18edacba723b299",
                  "executionId":"3",
                  "itemIndex":2,
                  "itemKey":"jidoka",
                  "itemResult":"OK",
                  "itemSubResult":null,
                  "itemSubResultText":null,
                  "itemResultDetail":"jidoka",
                  "properties":[
                     {
                        "Time required":"0.33",
                        "Number of results":"315000"
                     }
                  ],
                  "currentTimeMillis":1586870440301,
                  "duration":3334,
                  "testing":false
               }
            ],
            "remainingAttempts":4,
            "priority":"NORMAL",
            "executionResults":[
               "5cf8eef7deac351a6604fdcd",
               "5cf8ee7edeac351a6604fdbb"
            ],
            "functionalData":[
               {
                  "b":"yellow"
               }
            ],
            "labels":[
               "roleoperation"
            ],
            "lastUpdatedTimestamp":1561457843866,
            "createdTimestamp":1461457843868,
            "lastNodeName":"Machine 1",
            "lastNodeId":"5cf8ee2cdeac351a6604e01"
         }
      ]
   },
   "exceptionThrownText":null
}

Troubleshooting

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

None

Feedback

Was this page helpful?