阅读和查看 Automation Anywhere 文档

Automation 360

关闭内容

内容

打开内容

列出 WLM 队列

  • 已更新:2022/03/31
    • Automation 360 v.x
    • 探索
    • RPA Workspace
    • API 文档

列出 WLM 队列

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

请求

POST http://{{ControlRoomURL}}/v3/wlm/queues/list
Header: X-Authorization <<authentication token>>
所有 API 调用都必须在请求标头中包含身份验证令牌。使用 身份验证 API 生成 JSON Web 令牌。 看 身份验证 API.
没有过滤器的请求正文
{
   "sort":[
      {
         "field":"name",
         "direction":"asc"
      }
   ],
   "filter":{
      
   },
   "fields":[
      
   ],
   "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
}
}

请求参数

参数 类型 必填 描述
种类 数组 默认情况下,搜索结果按其 ID 降序排序。另一种排序是使用 sort 查询参数指定的。

按您希望的排序方向 asc(升序)或 desc(降序)输入字段。有关排序的更多信息,请参阅 过滤、分页和排序

filter 对象 筛选结果。有关排序的更多信息,请参阅 过滤、分页和排序
字段 数组 根据字段筛选结果。
page 对象 page 对象允许您获取所需的页面。有关分页规则的更多信息,请参阅 过滤、分页和排序
对于上述示例请求,响应返回 名称 中包含 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
        }
    ]
}

响应参数

参数 类型 描述
offset 整数 起始列表偏移量,用于分页。
total 整数 记录总数。
totalFilter 整数 应用筛选器后的记录数。
列表 数组 队列列表数组。
列出角色对象
id 整数 特定队列的唯一 ID。
createdBy 整数 创建对象的用户的 ID。
createdOn 字符串 角色的创建时间戳。
updatedBy 整数 对角色进行了最新更新的用户的 ID。
updatedOn 字符串 角色的最新更新时间戳。
租户 ID 整数 租户的 ID。
版本 整数 角色实例的版本。
tenantUuid 字符串 租户的唯一 ID。
姓名 字符串 队列的名称。
description 字符串 队列说明。
重新激活阈值 整数 队列中要重新激活队列的最小工作项数。
status 字符串 队列的当前状态。这些值可以是 DRAFT、IN_USE 或 NOT_IN_USE。
手动处理时间 整数 手动处理队列所需的工作量。
手动处理时间单位 字符串 手工处理时间的单位。这些值可以是 SECONDS、MINUTES、HOURS 或 DAYS。
workItemProcessingOrders 数组 一组工作项处理订单。
工作项目模型 ID 整数 工作项模型的 ID。
displayColumnIds 数组 显示列 ID 列表的数组。
考虑重新激活阈值 布尔值 指示是否需要重新激活阈值的标志。
注: 您可以查看 Control Room APIs 在里面 Community Edition,但 API 功能有限。你需要有执照的 Automation 360 用于访问 API 全部功能的版本。
REST API 使用 HTTP 响应代码响应每个请求。 有关响应代码,请参阅 API 响应代码.
发送反馈