閱讀及檢閱 Automation Anywhere 文件

Automation Anywhere Automation 360

關閉內容

內容

開啟內容

要求機器人程式部署狀態 API

  • 已更新:2021/01/12

    要求機器人程式部署狀態 API

    部署時 bot ,您可能需要驗證 bot 部署的狀態。此 API 可讓您知道 bot 所部署的的部署狀態。

    先決條件

    註: 您可以在中查看, Control Room APIs Community Edition但 API 功能受限。您需要授權 Automation 360 版本才能存取 API 的完整功能。
    • 使用 驗證 API 來產生 JSON Web Token 。
    • 您需要 部署 ID 來跟蹤特定 bot的的部署狀態。這是的輸出 部署 bots API

    程序

    1. 將驗證令牌添加到請求標頭。
    2. 使用 POST 方法和端點 URL :<your _control_room _url>/v2/activity/list
      請求主體
      {
        "filter": {
          "operator": "eq",
          "field": "deploymentId",
          "value": "14c2b6f8-c2a0-4a57-959d-ef413df0d179"
        }
      }
    3. 發送請求。
      響應主體:在成功的請求中,此端點返回以下部署 狀態之一已完成未知已部署正在運行run_paused更新run_failedrun_abortedrun_time_outdeploy 失敗待發執行已排隊BOT_PRE_processing_successfulBOT_PRE_processing_failed
      {
          "page": {
              "offset": 0,
              "total": 13,
              "totalFilter": 1
          },
          "list": [
              {
                  "id": "e49cea73-01fb-4a10-a7de-ce3e7b83a5ae_0e6c0971292ea185",
                  "automationName": "deploy-test_20.05.01.17.08.35_jdoe_API",
                  "fileName": "deploy-test",
                  "filePath": "Automation Anywhere\\Bots\\deploytest\\deploy-test",
                  "type": "TASK",
                  "startDateTime": "2020-05-01T17:09:02Z",
                  "endDateTime": "2020-05-01T17:09:05Z",
                  "command": "",
                  "status": "COMPLETED",
                  "progress": 100,
                  "automationId": "22260",
                  "userId": "2538",
                  "deviceId": "894",
                  "currentLine": 1,
                  "totalLines": 1,
                  "fileId": "57911",
                  "modifiedBy": "2540",
                  "createdBy": "2538",
                  "modifiedOn": "2020-05-01T17:08:47.657801Z",
                  "createdOn": "2020-05-01T17:08:38.228573Z",
                  "deploymentId": "14c2b6f8-c2a0-4a57-959d-ef413df0d179",
                  "queueName": "",
                  "queueId": "",
                  "usingRdp": false,
                  "message": "",
                  "canManage": false,
                  "deviceName": "MyCompany-JohnDoe",
                  "userName": "jdoe"
              }
          ]
      }
      REST API 會以 HTTP 回應碼回應每個要求。有關響應代碼的詳細信息,請參見 API 回應碼
    傳送意見反饋