阅读和查看 Automation Anywhere 文档

Automation Anywhere Automation 360

关闭内容

内容

打开内容

请求机器人部署状态 API

  • 已更新:2021/01/12

    请求机器人部署状态 API

    部署 bot 时,您可能需要验证 bot 部署的状态。此 API 使您能够了解已部署的 bot 的部署状态。

    先决条件

    注: 您可以在 Community Edition 中查看 Control Room APIs,但 API 功能受限。您需要获得许可证的 Automation 360 版本才能访问 API 的全部功能。
    • 使用身份验证 API 生成 JSON Web 令牌。请参阅身份验证 API
    • 您需要部署 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. 发送请求。
      响应正文:在成功的请求中,此端点返回的部署状态为已完成进行中已失败
      {
          "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 响应代码
    发送反馈