列出 WLM 队列

Automation Anywhere Automation 360

关闭内容

内容

打开内容

下载 PDF

列出 WLM 队列

使用工作负载管理队列列表 API 获取与指定 Control Room 关联的所有队列的列表。

先决条件

您必须具备以下条件：

队列使用者权限
在 Control Room 中注册的用户的认证令牌
身份验证 API
端点 URL：<your_control_room_url>/v3/wlm/queues/list

将请求正文留空可请求所有可用队列的信息。在请求正文中添加一个或多个筛选器参数，以限制从所有可用 WLM 队列返回的信息。

支持的可筛选参数：

id

队列的数字标识符。

字段：id
类型：整数

{
  "filter": {
    "operator": "eq",
    "value": "7",
    "field": "id"
  }
}

名称

显示队列的名称。

字段：name
类型：字符串

{
  "filter": {
    "operator": "substring",
    "value": "Finance",
    "field": "name"
  }
}

状态

队列的状态，例如：草稿、正在使用或未使用。

字段：状态
类型：字符串

{
   "filter": {
    "operator": "eq",
    "value": "IN_USE",
    "field": "status"
  
}

过程

使用 POST 方法生成验证 JSON Web 令牌。
身份验证 API

使用 POST 方法和端点 URL：<your_control_room_url>/v3/wlm/queues/list

例如，使用以下 Control RoomURL：

https://192.0.2.0/v3/wlm/queues/list

使用请求正文中的筛选器可检索状态为 IN_USE 且其名称包含 Finance 的所有队列的列表。

请求正文：

{
  "sort": [
    {
      "field": "name",
      "direction": "asc"
    }
  ],
  "filter": {
    "operator": "and",
    "operands": [
      {
        "operator": "eq",
        "value": "IN_USE",
        "field": "status"
      },
      {
        "operator": "substring",
        "value": "Finance",
        "field": "name"
      }
    ]
  },
  "fields": [
    
  ],
  "page": {
    "offset": 0,
    "total": 14,
    "totalFilter": 10,
    "length": 100
  }
}

发送请求。

在 REST 客户端中，单击发送。
在 Swagger 界面中，单击执行。

响应将返回其名称中具有 Finance 且状态为 IN_USE 的队列的所有详细信息。

响应正文：

{
  "page": {
    "offset": 0,
    "total": 14,
    "totalFilter": 1
  },
  "list": [
    {
      "id": "12",
      "createdBy": "24",
      "createdOn": "2020-05-19T18:37:11.713311Z",
      "updatedBy": "24",
      "updatedOn": "2020-05-19T19:14:13.641004200Z",
      "tenantId": "1",
      "version": "11",
      "tenantUuid": "4db5b32c-5c4b-4aee-8ca0-f53ec241563c",
      "name": "Finance_WLM",
      "description": "Finance WLM Automation",
      "reactivationThreshold": "1",
      "status": "IN_USE",
      "manualProcessingTime": "0",
      "manualProcessingTimeUnit": "SECONDS",
      "workItemProcessingOrders": [
        {
          "columnId": "37",
          "priority": "1",
          "name": "",
          "sortDirection": "desc",
          "tenantUuid": "4db5b32c-5c4b-4aee-8ca0-f53ec241563c"
        },
        {
          "columnId": "38",
          "priority": "2",
          "name": "",
          "sortDirection": "asc",
          "tenantUuid": "4db5b32c-5c4b-4aee-8ca0-f53ec241563c"
        },
        {
          "columnId": "39",
          "priority": "3",
          "name": "",
          "sortDirection": "desc",
          "tenantUuid": "4db5b32c-5c4b-4aee-8ca0-f53ec241563c"
        }
      ],
      "workItemModelId": "7",
      "displayColumnIds": [
        "36",
        "37",
        "38",
        "39",
        "40"
      ],
      "considerReactivationThreshold": false
    }
  ]
}

发送反馈