阅读和查看 Automation Anywhere 文档

Automation Anywhere Automation 360

关闭内容

内容

打开内容

列出自动化计划 API

  • 已更新:2021/01/26

    列出自动化计划 API

    检索您有权查看的自动化计划的详细信息。

    先决条件

    注: 您可以在 Community Edition 中查看 Control Room APIs,但 API 功能受限。您需要获得许可证的 Automation 360 版本才能访问 API 的全部功能。
    • 使用身份验证 API 生成 JSON Web 令牌。请参阅身份验证 API
    • 必须为您分配一个角色,其中包含查看和管理我的文件夹中所有计划活动的权限。

    在此示例中,您列出按下一次运行日期和时间排序的所有已计划的自动化。

    过程

    1. 将认证令牌添加到请求标头。
    2. 使用 POST 方法和端点 URL:<control_room_url>/v1/schedule/automations/list
      请求正文
      {
         "sort":[
            {
               "field":"zonedNextRunDateTime",
               "direction":"asc"
            }
         ]
      }
    3. 发送请求。
      响应正文:该响应包括以下有关每个自动化的数据:
      • id:标识自动化的数值。在更新自动化删除自动化 API 中使用此参数。
      • 状态:所返回的已计划自动化状态为活动非活动
      {
          "page": {
              "offset": 0,
              "total": 3,
              "totalFilter": 3
          },
          "list": [
              {
                  "id": "661",
                  "name": "eodReport_28.20.10.12.23.02.48",
                  "fileId": "6598",
                  "status": "ACTIVE",
                  "deviceIds": [],
                  "description": "",
                  "rdpEnabled": false,
                  "scheduleType": "DAILY",
                  "dailyRecurrence": {
                      "interval": 3
                  },
                  "timeZone": "America/Los_Angeles",
                  "startDate": "2020-10-12",
                  "endDate": "",
                  "startTime": "23:30",
                  "repeatEnabled": true,
                  "repeatOccurrence": {
                      "runEvery": "3",
                      "timeUnit": "HOURS",
                      "endTime": "23:59"
                  },
                  "zonedNextRunDateTime": "2021-01-14T07:30:00Z",
                  "createdBy": "251",
                  "createdOn": "2020-10-13T06:01:51.992433Z",
                  "updatedBy": "251",
                  "updatedOn": "2021-01-11T07:30:00.082057Z",
                  "tenantId": "1",
                  "fileName": "wlm_28",
                  "filePath": "Automation Anywhere\\Bots\\West Coast",
                  "runAsUserIds": [
                      "251"
                  ],
                  "botInput": {},
                  "tenantUuid": "e100fbce-008c-04ec-4063-7af0af91fb2f",
                  "poolId": [
                      "23"
                  ],
                  "overrideDefaultDevice": false,
                  "runElevated": false
              },
              {
                  "id": "990",
                  "name": "accounts.20.12.16.10.51.59",
                  "fileId": "12501",
                  "status": "ACTIVE",
                  "deviceIds": [],
                  "description": "",
                  "rdpEnabled": false,
                  "scheduleType": "WEEKLY",
                  "weeklyRecurrence": {
                      "interval": 1,
                      "daysOfWeek": [
                          "TUE",
                          "THU",
                          "FRI"
                      ]
                  },
                  "timeZone": "Australia/Melbourne",
                  "startDate": "2021-01-16",
                  "endDate": "2021-12-24",
                  "startTime": "20:45",
                  "repeatEnabled": true,
                  "repeatOccurrence": {
                      "runEvery": "1",
                      "timeUnit": "HOURS",
                      "endTime": "23:59"
                  },
                  "zonedNextRunDateTime": "2021-01-19T09:45:00Z",
                  "createdBy": "1103",
                  "createdOn": "2021-01-11T18:59:31.182663Z",
                  "updatedBy": "1103",
                  "updatedOn": "2021-01-11T18:59:31.182669Z",
                  "tenantId": "1",
                  "fileName": "a_trigger",
                  "filePath": "Automation Anywhere\\Bots\\APAC",
                  "runAsUserIds": [
                      "80",
                      "36",
                      "1103"
                  ],
                  "botInput": {},
                  "tenantUuid": "e100fbce-008c-04ec-4063-7af0af91fb2f",
                  "poolId": [
                      "7"
                  ],
                  "overrideDefaultDevice": false,
                  "runElevated": false
              },
              {
                  "id": "989",
                  "name": "UpdateInventory.20.12.16.10.40.48",
                  "fileId": "11201",
                  "status": "ACTIVE",
                  "deviceIds": [],
                  "description": "",
                  "rdpEnabled": false,
                  "scheduleType": "NONE",
                  "timeZone": "Asia/Calcutta",
                  "startDate": "2021-12-16",
                  "endDate": "",
                  "startTime": "15:00",
                  "repeatEnabled": false,
                  "zonedNextRunDateTime": "2021-12-16T09:30:00Z",
                  "createdBy": "1103",
                  "createdOn": "2021-01-11T18:57:18.932407Z",
                  "updatedBy": "1103",
                  "updatedOn": "2021-01-11T18:57:18.932422Z",
                  "tenantId": "1",
                  "fileName": "appsheet",
                  "filePath": "Automation Anywhere\\Bots\\spreadsheets",
                  "runAsUserIds": [
                      "480",
                      "80",
                      "472"
                  ],
                  "botInput": {},
                  "tenantUuid": "e100fbce-008c-04ec-4063-7af0af91fb2f",
                  "poolId": [
                      "11"
                  ],
                  "overrideDefaultDevice": false,
                  "runElevated": false
              }
          ]
      }
      REST API 用 HTTP 响应代码响应每个请求。 有关响应代码,请参阅 API 响应代码
    发送反馈