阅读和查看 Automation Anywhere 文档

Automation Anywhere Automation 360

关闭内容

内容

打开内容

计划 bot 以运行 API

  • 已更新:1/28/2021
    • Automation 360 v.x
    • 探索
    • RPA 工作区

计划 bot 以运行 API

计划bot在无人值守的Bot Runner上,运行一次或定期运行。

先决条件

注: 您可以在 Control Room APIs 中查看 Community Edition,但 API 功能有限。您需要获得许可证的 Automation 360 Edition 才能访问 API 的全部功能。
  • 使用身份验证 API 生成 JSON Web 令牌。请参阅身份验证 API
  • 确保已为您分配了以下资源:
    • 查看和运行我的机器人功能权限
    • 为包含 bots 的文件夹运行和计划权限
    • 访问 Bot Runner 许可用户
    • 访问默认设备或设备池
      注: 如果与 Bot Runner 许可证关联的用户将默认设备分配给其帐户,则 bot 会部署在该设备上。如果未分配任何默认设备,或者您想选择其他设备,则必须指定设备池。

要计划 bot,请向 API 提供以下信息:

Parameter 必填 类型 描述
fileId 数字 bot 的标识符。按工作区 API 列出文件和文件夹
runAsUserIds 数字 已使用您的 Control Room 注册为无人值守 Bot Runner 的用户的标识符列出可用的无人值守Bot Runners API
poolIds 数字 具有至少一个活动设备的设备池标识符。
注: 如果与 Bot Runner 许可证关联的用户将默认设备分配给其帐户,则 bot 会部署在该设备上。如果未分配任何默认设备,或者您想选择其他设备,则必须指定设备池。
列出设备池 API

过程

  1. 将认证令牌添加到请求标头。
  2. 使用 POST 方法和端点 URL:<control_room_url>/v1/schedule/automations
    请求正文
    此示例请求主体包含计划让 bot 运行一次的必需参数。
    {
       "name":"UpdateInventory.20.12.16.10.40.48",
       "fileId":"14277",
       "poolIds":[
          "27"
       ],
       "timeZone":"Asia/Calcutta",
       "runAsUserIds":[
          "472",
          "480",
          "80"
       ],
       "startDate":"2020-12-16",
       "startTime":"15:00",
       "scheduleType":"NONE"
       }
    此示例请求主体包含计划让 bot 重复运行的必需参数。
    {
       "name":"UpdateInventory.20.12.16.10.40.48",
       "fileId":"14277",
       "poolIds":[
          "27"
       ],
       "timeZone":"Australia/Melbourne",
       "runAsUserIds":[
          "1103",
          "36",
          "80"
       ],
       "startDate":"2020-12-16",
       "repeatOccurrence":{
          "endTime":"23:59",
          "runEvery":"1",
          "timeUnit":"HOURS"
       },
       "repeatEnabled":true,
       "endDate":"2020-12-24",
       "startTime":"20:45",
       "weeklyRecurrence":{
          "interval":"1",
          "daysOfWeek":[
             "TUE",
             "THU",
             "FRI"
          ]
       },
       "scheduleType":"WEEKLY"
    }
  3. 发送请求。
    响应正文:两个示例响应包括有关自动化的以下信息:
    • id:标识自动化的数值。在更新自动化删除自动化 API 中使用此参数。
    • zonedNextRunDateTime:下次计划 bot 运行的日期和时间。
    这是 bot 计划运行一次的响应示例。
    {
        "id": "989",
        "name": "UpdateInventory.20.12.16.10.40.48",
        "fileId": "14277",
        "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\\appsheet",
        "runAsUserIds": [
            "480",
            "80",
            "472"
        ],
        "botInput": {},
        "tenantUuid": "e100fbce-008c-04ec-4063-7af0af91fb2f",
        "poolId": [
            "11"
        ],
        "overrideDefaultDevice": false,
        "runElevated": false
    }
    这是 bot 计划重复运行的响应示例。
    {
        "id": "990",
        "name": "UpdateInventory.20.12.16.10.40.48",
        "fileId": "14277",
        "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\\a_trigger",
        "runAsUserIds": [
            "80",
            "36",
            "1103"
        ],
        "botInput": {},
        "tenantUuid": "e100fbce-008c-04ec-4063-7af0af91fb2f",
        "poolId": [
            "7"
        ],
        "overrideDefaultDevice": false,
        "runElevated": false
    } 
    REST API 用 HTTP 响应代码响应每个请求。 有关响应代码,请参阅API 响应代码

后续步骤

使用 列出自动化计划 API 检索所有已计划的自动化的详细信息。
发送反馈