WorkQueue Quick Reference
--8<--
An implementation of Work Queues to manage tasks that need to be processed sequentially.
-->8--
/OpenForum/AddOn/WorkQueue Sevice API Version 0.1.5
Get Actions
Action addItemToQueue
Parameters
| Name | Description |
| name (required=true) | {{parameter.description}} |
| status (required=true) | {{parameter.description}} |
| slaTime (required=true) | {{parameter.description}} |
| data (required=true) | {{parameter.description}} |
| queue (required=true) | {{parameter.description}} |
Example Get Request
/OpenForum/AddOn/WorkQueue?action=addItemToQueue
Example Response
Example Error Response
Action getItemOnQueue
Parameters
| Name | Description |
| queue (required=true) | {{parameter.description}} |
| itemId (required=true) | {{parameter.description}} |
Example Get Request
/OpenForum/AddOn/WorkQueue?action=getItemOnQueue
Example Response
Example Error Response
Action moveItemToQueue
Parameters
| Name | Description |
| fromQueue (required=true) | {{parameter.description}} |
| itemId (required=true) | {{parameter.description}} |
| toQueue (required=) | {{parameter.description}} |
Example Get Request
/OpenForum/AddOn/WorkQueue?action=moveItemToQueue
Example Response
Example Error Response
Action setItemStatus
Parameters
| Name | Description |
| status (required=true) | {{parameter.description}} |
| itemId (required=true) | {{parameter.description}} |
| queue (required=) | {{parameter.description}} |
Example Get Request
/OpenForum/AddOn/WorkQueue?action=setItemStatus
Example Response
Example Error Response
Action setItemData
Parameters
| Name | Description |
| queue (required=true) | {{parameter.description}} |
| itemId (required=true) | {{parameter.description}} |
Example Get Request
/OpenForum/AddOn/WorkQueue?action=setItemData
Example Response
Example Error Response
Action setItemCompleted
Parameters
| Name | Description |
| queue (required=true) | {{parameter.description}} |
| itemId (required=true) | {{parameter.description}} |
Example Get Request
/OpenForum/AddOn/WorkQueue?action=setItemCompleted
Example Response
Example Error Response
Action setItemFailed
Parameters
| Name | Description |
| queue (required=true) | {{parameter.description}} |
| itemId (required=true) | {{parameter.description}} |
Example Get Request
/OpenForum/AddOn/WorkQueue?action=setItemFailed
Example Response
Example Error Response
Post Actions
Action addItemToQueue
Parameters
| Name | Description |
| name (required=true) | {{parameter.description}} |
| status (required=true) | {{parameter.description}} |
| slaTime (required=true) | {{parameter.description}} |
| data (required=true) | {{parameter.description}} |
| queue (required=true) | {{parameter.description}} |
Example Post Request
/OpenForum/AddOn/WorkQueue?action=addItemToQueue
Example Response
Example Error Response