Use filters to retrieve selected workload management queues

Send a post request with filters to retrieve specific workload management 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

    Replace the content in the angel brackets with information for your Control Room.

  • Method: POST

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. Add filter parameters in the request body to limit the information returned from all available workload management queues.

    This request is intended to return all workload management queues with an ID value greater than 6.

    {
  "filter": {
    "operator": "gt",
    "operands": [
      
    ],
    "field": "id",
    "value": "6"
  },
  "sort": [
    {
      "field": "id",
      "direction": "asc"
    }
  ],
  "page": {
    "offset": 0,
    "length": 100
  }
}
  4. Send the request.
    • In a REST Client, click SEND.
    • In Swagger interface, click Execute.

The response for this example returned only 1 queue that met the filter requirements.

Response body 
{
  "page": {
    "offset": 0,
    "total": 3,
    "totalFilter": 1
  },
  "list": [
    {
      "id": "7",
      "name": "q3",
      "status": "IN_USE",
      "description": "",
      "reactivationThreshold": "1",
      "manualProcessingTime": "1",
      "manualProcessingTimeUnit": "DAYS",
      "workItemModelId": "3",
      "considerReactivationThreshold": false,
      "createdBy": "25",
      "createdOn": "2019-09-10T21:04:26.760Z",
      "updatedBy": "0",
      "updatedOn": "2019-09-10T23:31:46.995Z",
      "tenantId": "1",
      "version": "24"
    }
  ]
}
Response headers 
 cache-control: no-cache, no-store, max-age=0, must-revalidate 
 connection: keep-alive 
 content-length: 527 
 content-security-policy: default-src 'self' 
 content-type: application/json 
 date: Mon, 23 Sep 2019 17:50:15 GMT 
 expires: 0 
 pragma: no-cache 
 x-content-type-options: nosniff 
 x-frame-options: SAMEORIGIN 
 x-xss-protection: 1; mode=block

Here is a Curl example of the same REST request. The example is formatted for readability.

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 "{ \"filter\": { \"operator\": \"gt\", 
\"operands\": [ ], \"field\": \"id\", \"value\": \"6\" }, \"sort\": [ { \"field\": \"id\", 
\"direction\": \"asc\" } ], \"page\": { \"offset\": 0, \"length\": 100 }}"