阅读和查看 Automation Anywhere 文档

Automation Anywhere

关闭内容

内容

打开内容

用于部署机器人的Enterprise Control Room API

  • 已更新:5/10/2019
    • 11.3.x
    • 探索
    • Enterprise
    • API 文档

用于部署机器人Enterprise Control Room API

使用Enterprise Control Room机器人部署 API 可以从外部系统或第三方应用程序触发机器人。

要将机器人部署到自动化环境中,当前用户必须登录Enterprise Control Room,选择机器人Bot Runner,然后选择“运行/计划”任务。

但是,随着自动化场景的扩展,对于从外部第三方应用程序部署/触发机器人的需求越来越高。

为了满足此业务需求,Automation Anywhere 发布了应用程序编程接口 (API),使用这些 API 可以从外部系统触发机器人

Enterprise Control Room用户可以在第三方/外部应用程序指定的事件开始时使用这些 API 将机器人(任务)部署到Bot Runner

注: 无法从Enterprise Control Room部署有人监督的机器人。只能从Enterprise Control Room部署无人监督的机器人

Enterprise Control Room API 的主要特性和业务优势

  • 可使用 Automation Anywhere API 从外部第三方系统部署机器人
  • API 的输入和输出基于 JSON(行业标准数据交换格式)。
  • 可使用脚本与 Automation Anywhere API 相结合的方式从外部应用程序/工作流编排机器人部署。
注: 只有在系统/用户使用身份验证 API 进行身份验证后,才能调用机器人部署 API

此外,用户需要具有“运行我的机器人”权限以及要部署机器人Bot Runner的权限。

部署 API

部署 API 用于将机器人部署到Bot Runner

API:<Enterprise Control Room URL>/v1/schedule/automations/deploy

例如,如果Enterprise Control Room URL 为 https://www.ultron.com:81,则机器人部署 API 将为 https://www.ultron.com:81/v1/schedule/automations/deploy

用户可以将三个参数作为 JSON 字符串传递。

  1. 具有相对路径的机器人名称 – 这是必需的参数。
  2. 采用 JSON 格式的Bot Runner和用户列表 – 这是必需的参数。
  3. 使用基于 RDP 的方法 – 这是可选的参数,默认情况下设置为 false

部署场景和相应的 JSON 字符串:

  1. 例如,机器人的名称为 Accounts机器人.atmx,而机器人位于“My Tasks”下
  2. 机器人将部署在 3 台计算机上
    • 第一台计算机主机名为 BR-1,用户为 U-1
    • 第二台计算机主机名为 BR-2,用户为 U-2
    • 第三台计算机主机名为 BR-3,用户为 U-3。
  3. 上述场景中的 JSON 字符串将为:

    {

    "taskRelativePath":"My Tasks\\Accounts机器人.atmx", "Bot Runners":

    [

    {

    "client":"BR-1", "user":"U-1"

    },

    {

    "client":"BR-2", "user":"U-2"

    },

    {

    "client":"BR-3", "user":"U-3"

    }

    ]

    }

机器人部署 API 响应代码

Http(s) 状态代码 响应 - 描述
200 成功创建自动化。
400 错误请求
401 需要身份验证
403 未经授权访问
409 冲突
500 内部服务器错误
发送反馈