List WLM queues

Use the Workload Management queues list API to get the list of all the queues that are associated with the specified Control Room. .

Request

POST http://{{ControlRoomURL}}/v3/wlm/queues/list

Header: X-Authorization <<authentication token>>

All API calls must contain either an authentication token from Authentication API (generates JSON Web token) or a bearer token from OAuth services. You cannot use both together in an API.

Request body without filters:

{
   "sort":[
      {
         "field":"name",
         "direction":"asc"
      }
   ],
   "filter":{
      
   },
   "page":{
      "offset":0,
      "total":100,
      "totalFilter":100,
      "length":200
   }
}

Request body with filters:

{
"sort": [
  {
   "field": "name",//set sort by criteria
   "direction": "asc"
  }
],
 "filter": {
    "operator": "and",
    "operands": [
      {
        "operator": "eq",
        "value": "DRAFT",
        "field": "status"
      },
      {
        "operator": "substring",
        "value": "Test",
        "field": "name"
      }
    ]
  },
"fields": [],
"page": {//return a limited number of results with offset for pagination
  "offset": 0,
  "total": 100,
  "totalFilter": 100,
  "length": 200
}
}

Request Parameters


Parameter	Type	Required	Description
sort	Array	No	By default, search results are sorted in descending order with respect to their ids. An alternative sorting is specified using the sort query parameter. Enter the field by which you want to sort along with the direction `asc` (ascending) or `desc` (descending). For more information on sorting, see Filtering, pagination, and sorting
filter	Object	No	Filters the result. For more information on sorting, see Filtering, pagination, and sorting
fields	Array	No	Filter the result based on the fields.
page	Object	No	The page object allows you to get the desired pages. For more information on pagination rules, see Filtering, pagination, and sorting

For the above sample request, the response returns all the details of the queue that has Test in their name and NOT_IN_USE as status.

Response

{
    "page": {
        "offset": 0,
        "total": 17,
        "totalFilter": 1
    },
    "list": [
        {
            "id": "32",
            "createdBy": "873",
            "createdOn": "2022-03-02T05:51:53.855636Z",
            "updatedBy": "873",
            "updatedOn": "2022-03-02T05:54:18.745722Z",
            "tenantId": "1",
            "version": "1",
            "tenantUuid": "b6e4eb84-f7ef-4dfd-a432-725b71de8142",
            "name": "for-docs-test",
            "description": "",
            "reactivationThreshold": "1",
            "status": "NOT_IN_USE",
            "manualProcessingTime": "0",
            "manualProcessingTimeUnit": "SECONDS",
            "workItemProcessingOrders": [],
            "workItemModelId": "28",
            "displayColumnIds": [
                "156",
                "157",
                "158",
                "159",
                "160"
            ],
            "considerReactivationThreshold": false
        }
    ]
}

Response Parameters


Parameter	Type	Description
offset	Integer	The starting list offset, used for pagination.
total	Integer	Total number of records.
totalFilter	Integer	Number of records after applying the filter.
List	Array	The array of List of queues.
List roles object
id	Integer	The unique Id of a specific queue.
createdBy	Integer	Id of the user who created the role.
createdOn	String	The creation timestamp of the role.
updatedBy	Integer	Id of the user who made a latest update to the role.
updatedOn	String	The latest update timestamp of the role.
tenantId	Integer	Id of the tenant.
version	Integer	Version of the role instance.
tenantUuid	String	Unique Id of the tenant.
name	String	Name of queue.
description	String	Description of queue.
reactivationThreshold	Integer	Minimum number of workItems in the queue to reactivate queue.
status	String	The current status of the queue. The values can be DRAFT, IN_USE, or NOT_IN_USE.
manualProcessingTime	Integer	Efforts required to process the queue manually.
manualProcessingTimeUnit	String	Unit of the manual Processing time. The values can be SECONDS, MINUTES, HOURS, or DAYS.
workItemProcessingOrders	Array	An array of work item processing orders.
workItemModelId	Integer	Id of the Work Item Model.
displayColumnIds	Array	An array displaying the list of column Ids.
considerReactivationThreshold	Boolean	Flag to indicate if the Reactivation Threshold is required or not.

注： You can view the Control Room APIs in the Community Edition, but API functionality is limited. You need a licensed Automation 360 Edition to access the full functionality of the APIs.

The REST API responds to each request with an HTTP response code. For response codes, see API response codes.