QueueInfo

The QueueInfo action provides information about the asynchronous actions that IDOL Content Component is processing, and allows you to cancel or change the priority of these actions. You can use the QueueInfo action to determine whether a task is complete, and retrieve the results of the task.

When you set QueueAction to GetStatus to check the status of actions, you can use the Sort-By and Sort-Order parameters to sort the returned actions. If you do not specify these parameters, the actions are sorted by the time they were received, with the most recent action listed first. You can also use the State parameter to filter the actions that are returned by their status.

QueueInfo is a synchronous action.

Examples

To return the status of all asynchronous actions:

http://localhost:1234/action=QueueInfo&QueueAction=GetStatus&QueueName=Async

To return the status of finished actions, sorted by the time the server finished processing them, with the most recently completed action listed first:

http://localhost:1234/action=QueueInfo&QueueAction=GetStatus&QueueName=Async&State=finished&Sort-By=finish-time&Sort-Order=descending

To change the priority of an action:

http://localhost:1234/action=QueueInfo&QueueAction=ChangePriority&QueueName=Aysnc&Token=MTAuMi4xMDUuMzQ6MTIzNDpGRVRDSDoxNDAyOTU3MzY4&Priority=100

Required Parameters

The following action parameters are required.

Parameter	Description
QueueAction	The action to perform on the queue.
QueueName	The name of the queue to return.

Optional Parameters

Parameter	Description
Priority	The new priority to assign, when you set QueueAction to ChangePriority.
Sort-By	The property to use to sort the actions that return.
Sort-Order	The order used to sort the actions that return.
State	The action state that you want to return results for.
Token	The token of a single action in the queue.