阅读和查看 Automation Anywhere 文档

Automation 360

关闭内容

内容

打开内容

日程 bot 运行 API

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

日程 bot 运行 API

安排一个 bot 在无人看管的情况下运行 Bot Runner 一次或多次。

先决条件

注: 您可以查看 Control Room APIs 在里面 Community Edition,但 API 功能有限。你需要有执照的 Automation 360 用于访问 API 全部功能的版本。
  • 所有 API 调用都必须在请求标头中包含身份验证令牌。使用 身份验证 API 生成 JSON Web 令牌。 看 身份验证 API.
  • 确保为您分配了以下资源:
    • 查看和运行我的机器人 功能权限
    • 包含文件夹的 运行和计划bots
    • 进入 Bot Runner 许可用户
    • 访问默认设备或设备池
      注: 如果用户与 Bot Runner 许可证有一个默认设备分配给他们的帐户, bot 部署在该设备上。如果未分配默认设备,或者您想选择不同的设备,则必须指定设备池。

安排一个 bot,您向 API 提供以下信息:

参数 必填 类型 描述
fileId 数字 的标识符 bot.按工作区 API 列出文件和文件夹
runAsUserIds 数字 向您注册的用户的标识符 Control Room 作为 无人值守的机器人运行程序列出可用的无人值守 Bot Runners API
status 字符串 指示是创建活动计划还是草稿计划。输入 ACTIVEDRAFT
poolIds 数字 具有至少一个活动设备的设备池的标识符。
注: 如果用户与 Bot Runner 许可证有一个默认设备分配给他们的帐户, bot 部署在该设备上。如果未分配默认设备,或者您想选择不同的设备,则必须指定设备池。
列出设备池 API
overrideDefaultDevice 布尔值

如果 Bot Runner 用户已分配给默认设备,并且您想指定设备池,请将此参数设置为 true

如果部署到默认设备,请将此参数设置为 false

过程

  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",
       "status":"ACTIVE"
       }
    此示例请求正文包含调度所需的参数 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",
       "status":"ACTIVE"
    }
  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 检索所有计划自动化的详细信息。
发送反馈