Automation Anywhere

Automation Anywhere

關閉內容

內容

開啟內容

用於擷取佇列工作項目清單的 API

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

用於擷取佇列工作項目清單的 API

Automation Anywhere 提供一個 REST API,可讓您擷取 Enterprise 控制室 所提供給指定佇列中的工作項目及其詳細資料清單。此清單可用來透過聊天應用程式與客戶分享工作項目的結果。

API 端點

身為具有 [佇列管理員] 角色或 [佇列擁有者]、[參與者] 和/或 [取用者] 權限的Enterprise 控制室使用者,您可以使用「取得所有佇列」API 來存取特定佇列的工作項目清單。

使用下列端點來存取此 API:

<Enterprise 控制室URL>/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
    端點產生權杖。為此,請提供Enterprise 控制室執行個體當做 [伺服器名稱]/[主機名稱]/[IP][連接埠號碼]。例如:
    https://crdevenv.com:81/v1/authentication
  2. 使用 GET 方法來存取工作負載 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

    您可以檢視 Body 資料中的結果。例如:

    { "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 控制室中有顯示佇列
500 內部伺服器錯誤 確保伺服器連線可用
傳送意見反饋