Retrieve data on all available queues

Send a post request from the workload management API to retrieve all queues for your Control Room.

Prerequisites

AAE_Queue Admin role
You need a user account with the AAE_Queue Admin role to query and manage workload queues and work items in an Control Room.
JSON Web Token (JWT)
All Control Room APIs require a JSON Web Token (JWT) to access the APIs. Generate an authentication token using the Enterprise 11 Authentication API.
  • URL: http://<your_control_room_url>/v2/wlm/queues/list
  • Method: POST
Note:
  • Use the Swagger definition files installed with your Control Room to test the APIs. View the available Swagger APIs at http://<your_control_room_url>/swagger/.
  • You can also use a REST client to complete this task.

Procedure

  1. Add an authentication token to the request header.
    Note: Use the Enterprise 11 Authentication API to generate a JSON Web Token.
  2. Select POST as the method.
  3. Leave the request body blank to request information on all available workload management queues.
    Request body: 
    {}
  4. Send the request.
    • In a REST Client, click SEND.
    • In the Swagger interface, click Execute.

    The response for this example returned data for 3 queues. When the there is no filtering used in the request, a successful responses returns all of the queues for the specified Control Room.

    Response body:
      "page": {
    "offset": 0,
    "total": 3,
    "totalFilter": 3
  },
  "list": [{
    "id": "5",
    "name": "q1",
    "status": "IN_USE",
    "description": "",
    "reactivationThreshold": "1",
    "manualProcessingTime": "0",
    "manualProcessingTimeUnit": "SECONDS",
    "workItemModelId": "1",
    "considerReactivationThreshold": false,
    "createdBy": "25",
    "createdOn": "2019-09-10T21:02:46.067Z",
    "updatedBy": "0",
    "updatedOn": "2019-09-10T23:31:16.681Z",
    "tenantId": "1",
    "version": "31"
  }, {
    "id": "6",
    "name": "q2",
    "status": "IN_USE",
    "description": "",
    "reactivationThreshold": "1",
    "manualProcessingTime": "1",
    "manualProcessingTimeUnit": "HOURS",
    "workItemModelId": "2",
    "considerReactivationThreshold": false,
    "createdBy": "25",
    "createdOn": "2019-09-10T21:03:36.897Z",
    "updatedBy": "0",
    "updatedOn": "2019-09-10T23:31:17.004Z",
    "tenantId": "1",
    "version": "22"
  }, {
    "id": "7",
    "name": "q3",
    "status": "IN_USE",
    "description": "",
    "reactivationThreshold": "1",
    "manualProcessingTime": "1",
    "manualProcessingTimeUnit": "DAYS",
    "workItemModelId": "3",
    "considerReactivationThreshold": true,
    "createdBy": "25",
    "createdOn": "2019-09-10T21:04:26.760Z",
    "updatedBy": "25",
    "updatedOn": "2019-09-26T20:54:33.658Z",
    "tenantId": "1",
    "version": "27"
  }]
}
    Response headers 
     cache-control: no-cache, no-store, max-age=0, must-revalidate 
 connection: keep-alive 
 content-length: 1415 
 content-security-policy: default-src 'self' 
 content-type: application/json 
 date: Mon, 23 Sep 2019 17:17:28 GMT 
 expires: 0 
 pragma: no-cache 
 x-content-type-options: nosniff 
 x-frame-options: SAMEORIGIN 
 x-xss-protection: 1; mode=block
Note: You can also run REST requests from a command terminal. Here is a Curl example of the request. This example is formatted for readability. Replace text inside the angel brackets, <text>, with the appropriate values.
curl -X POST "http://<your_control_room_url>/v2/wlm/queues/list" 
-H "accept: application/json" 
-H "X-Authorization: <authentication_token>" 
-H "Content-Type: application/json" -d "{}"