阅读和查看 Automation Anywhere 文档

Automation Anywhere Automation 360

关闭内容

内容

打开内容

在队列中列出 Work Items

  • 已更新:9/09/2020
    • Automation 360 v.x
    • 探索
    • RPA 工作区
    • API 文档

在队列中列出 Work Items

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

先决条件

您必须具备以下条件:

  • 队列使用者权限
  • Control Room 中注册的用户的认证令牌

    身份验证 API

  • 端点 URL:<your_control_room_url>/v3/wlm/queues/{queueId}/workitems/list

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

支持的可筛选参数
状态
队列的状态,例如:新建、暂停、失败、已完成、数据错误、活动以及准备运行。
  • 字段状态
  • 类型字符串
{
   "filter": {
    "operator": "eq",
    "value": "ACTIVE",
    "field": "status"
    }  
}
result
Work Item 结果字符串。例如,Work Item 已完成或跳过。
  • 字段结果
  • 类型字符串
{
  "filter": {
    "operator": "substring",
    "value": "skipped",
    "field": "result"
  }
}
col
与自定义列名称对应的列号。例如,电子邮件、名字和姓氏。
  • 字段col
  • 类型字符串
{
  "filter": {
    "operator": "substring",
    "value": "Brian",
    "field": "col1"
  }
}

过程

  1. 使用 POST 方法生成验证 JSON Web 令牌。
  2. 使用 POST 方法和端点 URL:<your_control_room_url>/v3/wlm/queues/{queueId}/workitems/list
    例如,在以下 URL 中输入 queueId20,而您要获取其 Work Items
    https://192.0.2.0/v3/wlm/queues/20/workitems/list
    使用请求正文中的筛选器可检索状态为 NEW 且其名字 (col1) 包含 Brian 的所有 Work Items 的列表。

    请求正文:

    {
      "sort": [
        {
          "field": "computedStatus",
          "direction": "asc"
        }
      ],
      "filter": {
        "operator": "and",
        "operands": [
          {
            "operator": "eq",
            "value": "NEW",
            "field": "status"
          },
          {
            "operator": "substring",
            "value": "Brian",
            "field": "col1"
          }
        ]
      },
      "fields": [
        
      ],
      "page": {
        "offset": 0,
        "total": 5,
        "totalFilter": 1,
        "length": 100
      }
    }
  3. 发送请求。
    • 在 REST 客户端中,单击发送
    • 在 Swagger 界面中,单击执行
    响应将返回其 first_name (col1) 中包含 Brian 且状态为 NEW 的所有 Work Item 的详细信息。
    响应正文:
    {
      "page": {
        "offset": 0,
        "total": 5,
        "totalFilter": 1
      },
      "list": [
        {
          "id": "11804",
          "createdBy": "24",
          "createdOn": "2020-05-26T10:19:34.786711300Z",
          "updatedBy": "24",
          "updatedOn": "2020-05-26T10:19:34.786711300Z",
          "version": "1",
          "json": {
            "id": "1",
            "first_name": "Brian",
            "last_name": "Matthews",
            "email": "bmatthews0@example.com",
            "gender": "Male",
            "Address": "5773 Meadow Ridge Street",
            "Current Balance": "822034.72",
            "Current Card Type": "jcb",
            "Average Bank Balance": "$1,25,365.58 ",
            "Account Number": "1651249",
            "Amount Requested": "12750",
            "Recommended": "6375",
            "Phone": "8607826062"
          },
          "result": "",
          "deviceId": "0",
          "status": "NEW",
          "col1": "Brian",
          "col2": "Matthews",
          "col3": "bmatthews0@example.com",
          "col4": "",
          "col5": "",
          "deviceUserId": "0",
          "queueId": "20",
          "comment": "",
          "automationId": "0",
          "totalPausedTime": "0",
          "error": "",
          "col6": "",
          "col7": "",
          "col8": "",
          "col9": "",
          "col10": ""
        }
      ]
    }
发送反馈