阅读和查看 Automation Anywhere 文档

Automation Anywhere

关闭内容

内容

打开内容

用于获取队列工作项列表的 API

  • 已更新:5/29/2019
    • 11.3.x
    • 探索
    • Enterprise
    • API 文档

用于获取队列工作项列表的 API

Automation Anywhere 提供了一个 REST API,让您可以获取 Enterprise Control Room 中可用的给定队列中的工作项列表及其详细信息。此列表可用于通过聊天应用程序与客户共享工作项的结果。

API 端点

作为具有“队列管理员”角色或“队列所有者”、“参与者”和/或“使用者”权限的 Enterprise Control Room 用户,您可以使用“获取所有队列”API 访问特定队列的工作项列表。

使用以下端点访问 API:

<Enterprise Control RoomURL>/v2/wlm/queues/<queue-id>/workitems/list

例如:

https://crdevenv.com:81/v2/wlm/queues/1/workitems/list 

列出所有队列

  1. 使用 Post 方法生成使用端点
    http(s)://<hostname:port>/v1/authentication
    的令牌。为此,请以服务器名称/主机名/IP端口号的形式提供 Enterprise Control Room 实例。例如:
    https://crdevenv.com:81/v1/authentication
  2. 使用 GET 方法访问 Workload API 和特定队列中的工作项。例如:
    POST https://crdevenv.com:81/v2/wlm/queues/1/workitems/list
  3. 在标头中提供下列请求参数
    "X-Authorization" : "Authorization Token" "Content-Type": "application/json"
  4. 在请求正文中提供以下参数。例如:
    { "sort": [ ], "filter": { "operator": "or", "operands": [ { "field": "id", "operator": "eq", "value": "1" }, { "field": "id", "operator": "eq", "value": "2" } ] }, "fields": [ ], "page": { "length": 200, "offset": 0 } }
  5. 以下响应状态表明操作成功:
    200 OK

    您可以在“正文”数据中查看结果。例如:

    { "page": { "offset": 0, "total": 16, "totalFilter": 2 }, "list": [ { "id": 1, "createdBy": 2, "createdOn": "2019-01-23T23:03:36.339Z", "updatedBy": 2, "updatedOn": "2019-01-23T23:03:36.339Z", "tenantId": 1, "version": 0, "json": "{"Invoice ID":"IN0001","Customer Name ":"Jason Goodman","Amount":400000,"Email":"jason@aae.com","Invoice Date":"12-03-2019"}", "result": "", "deviceId": 0, "status": "Ready to run", "col1": "IN0001", "col2": "", "col3": "", "col4": "", "col5": "", "brUserId": 0, "queueId": 1, "comment": "", "botId": 0, "poolId": 0, "automationId": 0, "totalPausedTime": "0" }, { "id": 2, "createdBy": 2, "createdOn": "2018-08-23T23:03:36.361Z", "updatedBy": 2, "updatedOn": "2018-08-23T23:03:36.361Z", "tenantId": 1, "version": 0, "json": "{"Invoice ID":"IN0002","Customer Name ":"Ellie Brown","Amount":700000,"Email":"ellie@aae.com","Invoice Date":"12-03-2019"}", "result": "", "deviceId": 0, "status": "Ready to run", "col1": "IN0002", "col2": "", "col3": "", "col4": "", "col5": "", "brUserId": 0, "queueId": 1, "comment": "", "botId": 0, "poolId": 0, "automationId": 0, "totalPausedTime": "0" } ] }

API 响应代码

Http(s) 状态代码 响应 - 描述 纠正措施
200 成功列出工作项 不适用
400 请求参数错误 使用有效参数重试
401 需要身份验证 提供身份验证参数
403 未经授权访问 提供具有访问权限的用户的身份验证参数
404 未找到文件 确保Enterprise Control Room中包含该队列
500 内部服务器错误 确保服务器连接可用
发送反馈