列出工作負載管理隊列

使用工作負載管理隊列列表 API 獲取與指定的關聯的所有隊列的列表 Control Room.要執行此 API，您必須具有隊列消費者權限。

要求

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

Header: X-Authorization: <<authentication token>> or Authorization: Bearer <<bearer token>>

所有 API 調用都必須包含來自驗證 API （生成 JSON Web 令牌）或來自 OAuth 服務的不記名令牌。您不能在 API 中同時使用兩者。

沒有過濾器的請求正文：

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

帶過濾器的請求正文：

{
"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
}
}

要求參數


參數	類型	必填	說明
sort	陣列	否	依預設，搜尋結果會依其 ID 以遞減順序排序。使用排序查詢參數指定其他排序方式。輸入要作為排序依據的欄位及其方向為 `asc` (遞增) 或 `desc` (遞減)。有關排序的更多信息，請參見篩選、分頁和排序
篩選	物件	否	篩選結果。有關排序的更多信息，請參見篩選、分頁和排序
欄位	陣列	否	根據欄位篩選結果。
頁	物件	否	頁面物件可讓您取得所需的頁面。有關分頁規則的更多信息，請參閱篩選、分頁和排序

對於上述示例請求，響應返回名稱中包含 TestNOT_IN_USE 。

回應

{
    "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
        }
    ]
}

回應參數


參數	類型	說明
偏移	整數	用於分頁的開始清單偏移值。
總計	整數	記錄總次數。
totalFilter	整數	套用篩選後的記錄次數。
清單	陣列	隊列列表的數組。
列出角色對象
ID	整數	特定隊列的唯一 ID。
createdBy	整數	建立角色的使用者 ID。
createdOn	字串	建立角色的時間戳記。
更新者	整數	最近一次更新角色的使用者 ID。
更新日期	字串	最近一次更新角色的時間戳記。
租戶ID	整數	租戶的ID。
版本	整數	角色實例的版本。
tenantUuid	字串	租戶的唯一 ID。
名稱	字串	隊列名稱。
說明	字串	隊列說明。
再激活閾值	整數	隊列中要重新激活隊列的最小工作項數。
status	字串	隊列的當前狀態。這些值可以是 DRAFT、IN_USE 或 NOT_IN_USE。
人工處理時間	整數	手動處理隊列所需的工作量。
手動處理時間單位	字串	手動處理時間的單位。值可以是秒、分鐘、小時或天。
工作項處理訂單	陣列	一組工作項處理訂單。
工作項模型 ID	整數	工作項模型的 ID。
顯示列 ID	陣列	顯示列 ID 列表的數組。
考慮重新激活閾值	布林值	指示是否需要重新激活閾值的標誌。

註: 您可以查看 Control Room APIs 在裡面 Community Edition，但 API 功能有限。你需要一個許可 Automation 360 版本以訪問 API 的全部功能。

REST API 使用 HTTP 響應代碼響應每個請求。有關響應代碼，請參閱 API響應代碼.