すべての利用可能なキューでデータを取得

WLM API から POST リクエストを送信し、Control Room のすべてのキューを取得します。

前提条件

AAE_Queue Admin ロール
Control Room でワークロード クエリと作業項目を管理するには、AAE_Queue Admin ロールを持つユーザー アカウントが必要です。
JSON Web トークン (JWT)
すべての Control Room API には API にアクセスするための JSON Web トークン (JWT) が必要です。認証 API を使用して認証トークンを生成します。
  • URL: http://<your_control_room_url>/v2/wlm/queues/list
  • メソッド: POST
注:
  • API をテストするには、Control Room にインストールされた Swagger 定義ファイルを使用します。利用可能な Swagger API は http://<your_control_room_url>/swagger/ で参照できます。
  • また、REST Client を使用してこのタスクを完了することもできます。

手順

  1. リクエスト ヘッダーに認証トークンを追加します。
    注: 認証 API を使用して JSON Web トークンを生成します。
  2. [POST] メソッドを選択します。
  3. 利用できるすべての WLM キューの情報をリクエストするには、リクエスト本文を空白にします。
    リクエスト本文:
    {}
  4. リクエストを送信します。
    • REST Client で [SEND] をクリックします。
    • Swagger インターフェースで [実行] をクリックします。

    この例では、レスポンスは 3 つのキューでデータを返しています。リクエストにフィルタリングがない場合、指定した Control Room のすべてのキューでレスポンスが正常に返されます。

    レスポンス本文:
      "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"
  }]
}
    レスポンス ヘッダー
     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
注: また、コマンド ターミナルから REST リクエストを実行することもできます。これは、リクエストの Curl 例です。この例は、読みやすいようにフォーマットされています。かぎ括弧内のテキスト <text> を適切な値に置き換えます。
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 "{}"