阅读和查看 Automation Anywhere 文档

Automation 360

关闭内容

内容

打开内容

列出自动化计划 API

  • 已更新:2021/08/10
    • Automation 360 v.x
    • 探索
    • RPA Workspace

列出自动化计划 API

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

先决条件

注: 您可以查看 Control Room APIs 在里面 Community Edition,但 API 功能有限。你需要有执照的 Automation 360 用于访问 API 全部功能的版本。
  • 所有 API 调用都必须在请求标头中包含身份验证令牌。使用 身份验证 API 生成 JSON Web 令牌。 看 身份验证 API.
  • 必须为您分配一个角色,该角色包括 从我的文件夹查看和管理所有计划的活动 权限。

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

过程

  1. 将身份验证令牌添加到请求标头。
  2. 使用 POST 方法和端点 URL:<control_room_url>/v1/schedule/automations/list
    请求正文:
    {
       "sort":[
          {
             "field":"zonedNextRunDateTime",
             "direction":"asc"
          }
       ]
    }
  3. 发送请求。
    回复正文:响应包括有关每个自动化的以下数据:
    • id:标识自动化的数值。更新自动化删除自动化 API中使用此参数 。
    • status:返回计划的自动化是 ACTIVE 还是 INACTIVE
    {
        "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 响应代码.
发送反馈