List Work Items in queue
Use the Workload Management Work Item list API to get the list of all the Work Items in the queues that are associated with the specified Control Room.
Prerequisites
You must have the following:
- Queue Consumer permission
- An authentication token for a user registered in the Control Room
- The endpoint URL:
<your_control_room_url>/v3/wlm/queues/{queueId}/workitems/list
Leave the request body blank to request information on all available Work Items. Add one or more filter parameters in the request body to limit the information returned from all available WLM Work Items.
Supported filterable parameters:
- status
- The status of queue for example: New, On hold, Failed, Completed, Data
error, Active, and Ready to run.
- Field: status
- Type: string
{ "filter": { "operator": "eq", "value": "ACTIVE", "field": "status" } }
- result
- The Work Item result string. For example, the Work Item was completed or skipped.
- Field: result
- Type: string
{ "filter": { "operator": "substring", "value": "skipped", "field": "result" } }
- col
- The column number corresponding to the custom column name. For example,
email, firstname, and lastname.
- Field: col
- Type: string
{ "filter": { "operator": "substring", "value": "Brian", "field": "col1" } }