| 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: /queue/resubmit/item
This method is used to resubmit an item to its queue. When an item is submitted again to the queue, both queue item and queue are affected.
Queue items can have the following statuses:
FINISHED_WARN: You can make changes to the queue item before resubmitting it. The previous processing finished but with warnings.FINISHED_OK: You can't make changes to the queue item because it's finished being processed.IN_PROCESS: You can't make changes to the queue item because it's currently being processed.PENDING: It isn't recommended to make changes to the queue item before resubmitting it.DISABLED: It isn't recommended to make changes to the queue item before resubmitting it.Queues can have the following statuses:
PENDINGIN_PROCESSFINISHEDRESERVED: You can't make changes to the queue.CLOSEDAfter you resubmit a queue item, both the item's and the queue's status change to PENDING.
| Parameter | Example | Required? | Description |
|---|---|---|---|
id |
"5da83220cabb54eb6f685eea" | Yes | Internal id of the queue item |
key |
"testKey" | No | The item's key |
reference |
"PENDING" | No | Item's state. Possible values are DISABLED, PENDING, IN_PROCESS, FINISHED_OK, FINISHED_WARN |
remainingAttempts |
10 | No | Number of remaining attempts |
priority |
"HIGH" | No | Queue item's priority, possible values are HIGHEST, HIGHER, HIGH, NORMAL, LOW, LOWER, and LOWEST |
functionalData |
{"a": "1", "b": "2","c": "3"} | No | Functional data associated with the queue item |
labels |
["11", "12"] | No | Permission tags for the queue item |
Example request body:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
{
"id":"5da83220cabb54eb6f685eea",
"key":"testKey",
"reference":"PENDING",
"remainingAttempts":10,
"priority":"HIGH",
"functionalData":{
"a":"1",
"b":"2",
"c":"3"
},
"labels":[
"11",
"12"
]
}
The call is successful if "invocationResult" = "OK".
The following elements are provided in the result.item key.
| Element | Example | Data type | Description |
|---|---|---|---|
id |
"5cf8ec61deac351a6604fd74" | String | Internal id of the queue item |
queueId |
"5cf8ec2adeac351a6604fd71" | String | Queue id to which the item belongs |
queueName |
"nasdaq-queue-warnings-1attempt" | String | Queue name to which the item belongs |
key |
"testKey" | String | key |
reference |
Array | Array of data including details about the queues item's state | |
state |
"PENDING" | String | Item's state. Possible values are DISABLED, PENDING, IN_PROCESS, FINISHED_OK, FINISHED_WARN |
duration |
33 | Integer | Duration in milliseconds |
lastExecutionResult |
- | Array | Array of data including details about the robotic task to last execute the queue and item, described below. |
lastExecutionResult.id |
null | String | Internal id for the executed robotic task |
lastExecutionResult.robotName |
"5e4a72abe18edacba723b298" | String | Robotic task name, immutable since creation |
lastExecutionResult.robotId |
"5e4a72abe18edacba723b299" | String | Unique id for the executed robotic task |
lastExecutionResult.executionNumber |
"1" | Integer | Execution number |
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 items was processes, expressed in UNIX epoch time |
lastExecutionResult.duration |
3334 | String | Duration in milliseconds |
lastExecutionResult.testing |
false | Boolean | Boolean indicating whether this execution was a test |
remainingAttempts |
9 | Integer | Number of remaining attempts |
priority |
"HIGH" | String | Priority, possible values are HIGHEST, HIGHER, HIGH, NORMAL, LOW, LOWER, and LOWEST |
executionResults |
"5da84a6bcabb54eb6f685f30" | String | List of executions where this queue item was processed |
functionalData |
{"a": "1","b": "2","c": "3"} | Array | Functional data associated with the queue item |
labels |
["11", "12"] | Array | Permission tags for this queue item |
lastUpdatedTimestamp |
1542807938000 | String | Date and time the queue item was last updated, expressed in UNIX epoch time Units: milliseconds |
createdTimestamp |
1542807935990 | String | Date and time the queue item was created, expressed in UNIX epoch time Units: milliseconds |
lastNodeName |
"Machine 1" | String | Name of the robot to process the last queue item |
lastNodeId |
"5dad800406938caad291b213" | String | Id of the robot to process the last queue item |
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
57
58
59
60
61
62
63
64
65
66
{
"invocationResult":"OK",
"result":{
"lastUpdated":1627668581125,
"errorMessage":null,
"nextPageToken":null,
"items":[
{
"id":"5cf8ec61deac351a6604fd74",
"queueId":"5cf8ec2adeac351a6604fd71",
"queueName":"nasdaq-queue-warnings-1attempt",
"key":"testKey",
"reference":[
{
"state":"PENDING"
}
],
"duration":3334,
"lastExecutionResult":[
{
"id":null,
"robotName":"5e4a72abe18edacba723b298",
"robotId":"5e4a72abe18edacba723b299",
"executionNumber":"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":[
{
"a":"1",
"b":"2",
"c":"3"
}
],
"labels":[
"roleoperation"
],
"lastUpdatedTimestamp":1561457843866,
"createdTimestamp":1461457843868,
"lastNodeName":"Machine 1",
"lastNodeId":"5dad800406938caad291b213"
}
]
},
"exceptionThrownText":null
}
Possible reasons calls may be unsuccessful ("invocationResult" = "KO"):
Resubmit Queue Item
