部署 bots API

Automation Anywhere Automation 360

关闭内容

内容

打开内容

下载 PDF

部署 bots API

作为具有 Bot Runner 许可证的用户，请在分配的设备上部署 bots。您也可以在部署变量时将其传递到 bots。

先决条件

注：您可以在 Control Room APIs 中查看 Community Edition，但 API 功能有限。您需要获得许可证的 Automation 360 Edition 才能访问 API 的全部功能。

确保已为您分配了以下资源：

查看和运行我的机器人功能权限
为包含 bots 的文件夹运行和计划权限
访问 Bot Runner 许可用户
访问默认设备或设备池
注：如果与 Bot Runner 许可证关联的用户将默认设备分配给其帐户，则 bot 会部署在该设备上。如果未分配任何默认设备，或者您想选择其他设备，则必须指定设备池。

要部署 bot 并将变量值传递到 bot，请提供以下信息到 API：


Parameter	必填	类型	描述
fileId	是	数字	要部署的 bot 的标识符。按工作区 API 列出文件和文件夹
runAsUserIds	是	数字	已在 Control Room 上注册为无人值守的 Bot Runner 的用户的标识符。列出可用的无人值守Bot Runners API
poolIds	否	数字	具有至少一个活动设备的设备池的标识符。注：如果与 Bot Runner 许可证关联的用户将默认设备分配给其帐户，则 bot 会部署在该设备上。如果未分配任何默认设备，或者您想选择其他设备，则必须指定设备池。列出设备池 API
overrideDefaultDevice	否	布尔值	如果 Bot Runner 用户已分配给默认设备，并且您想指定设备池，请将此参数设置为 `true`。如果部署到默认设备，请将此参数设置为 `false`。
botInput	否	Varies	指定输入变量名称、值和数据类型。
numOfRunAsUsersToUse	否	数字	指定从 runAsUserIds 列表中要使用的 Bot Runners 数量。加权系统算法选择排队任务数量最少的 Bot Runners。
callbackInfo	否	物品	为调回服务器提供 URL 和身份验证令牌。bot 部署后，Control Room 会将部署状态和输出变量值发送到此调回服务器。

过程

将认证令牌添加到请求标头。

使用 POST 方法和端点 URL： <your_control_room_url>/v3/automations/deploy.

请求正文：

此示例请求正文指定输入变量的必需参数以及值。

{
  "fileId": 14277,
  "runAsUserIds": [
    2538
  ],
  "botInput": {
    "sDocHello": {
      "type": "STRING",
      "string": "Hello world, go be great."
    }
  }
}

此示例请求正文指定四个 runAsUserIds 和两个 numOfRunAsUsersToUse。加权算法选择两个在部署请求时排队的任务数量最少的 Bot Runners。

{
  "fileId": 14277,
  "runAsUserIds": [
    2538,
    4256,
    2213,
    789
  ],
   "poolIds": [
    27
  ],
  "numOfRunAsUsersToUse": 2
}

此示例请求正文包括 overrideDefaultDevice 设置为 true，因此 bot 将部署到设备池而不是作为用户的默认设备运行。此示例还包含用于指定调回服务器 URL 并提供授权的语法。

{
  "fileId": 14277,
  "runAsUserIds": [
    245
  ],
   "poolIds": [
    27
  ],
  "overrideDefaultDevice": true,
  "callbackInfo": {
    "url": "https://callbackserver.com/storeBotExecutionStatus",
    "headers": {
      "X-Authorization": "eyJhbGciOiJSUzUxMiJ9.eyJzdWIiOiI0Ii"
    }
  }
}

发送请求
响应正文：
成功后，Bot部署 API 将使用 deployId 返回响应。
```
{
  "deploymentId": "14c2b6f8-c2a0-4a57-959d-ef413df0d179"
}
```
REST API 用 HTTP 响应代码响应每个请求。有关响应代码，请参阅API 响应代码。

后续步骤

执行此任务：请求机器人部署状态 API。

发送反馈