阅读和查看 Automation Anywhere 文档

Automation Anywhere

关闭内容

内容

打开内容

用于导出和导入工作负载管理配置的 API

  • 已更新:5/10/2019

    用于导出和导入工作负载管理配置的 API

    作为具有“导出和导入机器人”权限的Enterprise Control Room管理员或用户,您可以导出和导入工作负载配置,将经过验证的配置从一个环境移到另一个环境。

    例如,您可以将经验证处于生产就绪状态的队列从暂存环境移到生产环境。

    您可以根据贵组织的自动化需求,使用Enterprise Control Room导出和导入 REST API,以便在开发、测试、验收和正式部署等不同的环境中管理自动化。

    特点和优点

    • 对工作负载管理模块进行基于角色的访问控制
    • 对源和目标环境合规性进行审核和跟踪

    先决条件

    导出

    • 凭证用于身份验证的Enterprise Control Room用户必须是管理员或应具有导出机器人权限
    • Enterprise Control Room用户必须是队列管理员或队列所有者才能导出特定的队列
    • 由于队列所有者、使用者、参与者的详情不包含在导出中,因此您需要在导入后根据需要手动添加这些内容。
    • 用于运行Enterprise Control Room服务的用户账户必须对包正在导出到的文件夹具有读/写访问权限;该文件夹位置就是应用程序路径,可以位于网络位置(共享驱动器)或本地计算机。

      例如:

      C:\Users\Public\Documents\Server Files\wlm-files\export

    • 一个包中最多可导出 200 个队列
    • 处于草稿状态的队列无法导出
    • 如果有任何队列导出失败,则整个导出操作就会失败。

    导入

    • 凭证用于身份验证的Enterprise Control Room用户必须具有导入机器人权限
    • Enterprise Control Room队列管理员可以导入所有队列。
    • 将使用 API 导入多个机器人的Enterprise Control Room用户必须对 Automation Anywhere 提供的导出包文件所在的文件夹具有/访问权限;该文件夹位置就是应用程序路径,可以位于网络位置(共享驱动器)或本地计算机。

      例如:

      C:\Users\Public\Documents\Server Files\wlm-files\import

    • 导入包的用户默认情况下将成为已导入队列的所有者。根据需要,在已导入队列上手动添加参与者使用者或额外的所有者
    • 如果任何先前的导入已创建某一队列类别,则只要所有列名称和类型匹配,后续导入就会仅使用该队列类别。

    API 端点

    1. 导出 - <Enterprise Control Room URL>/v1/wlm/queues

      例如,https://crdevenv.com:81/v1/wlm/queues

    2. 导入 - <Enterprise Control Room URL>/v1/wlm/queues

      例如:

      https://crtestenv.com:82/v1/wlm/queues

    通过使用 WLM 导出和导入 API 的上述端点,您可以导出和导入队列。

    导出队列

    要使用 Automation Anywhere 提供的导出 API 来导出队列,请按照以下步骤操作:

    1. 使用 POST 方法生成使用端点 http(s)://<hostname:port>/v1/authentication 的令牌。为此,请以服务器名称/主机名/IP端口号的形式提供Enterprise Control Room实例。

      例如,https://crdevenv.com:81/v1/authentication

    2. 使用 POST 方法并在正文数据中指出凭证的参数。

      例如:

      {

      "username":"Mike.Lee",

      "password":"1234567890"

      }

    3. 单击播放/开始/发送
    4. 工作负载导出 API 将使用通过身份验证 API 获取的身份验证令牌。该身份验证令牌必须作为某一标头输入传递给工作负载导出 API。
    5. 提供请求参数 X-AuthorizationAcceptqueue-ids 作为标头。

      例如:

      {

      "X-Authorization":"authorization token issued by Enterprise Control Room after login",

      "Accept":"application/json/file",

      "queue-ids":"1,2,3,4,5"

      }

    6. 单击“播放/开始/发送”
    7. 当响应状态为 200 OK 时,操作成功。
    8. 从响应帧中复制包名称。您可以使用它来导入队列包。
      提示: 确保导入包具有正确的扩展名:.wlmpkg

      例如,复制 content-disposition 中给出的 filename

      cache-control → no-cache, no-store, max-age=0, must-revalidate

      content-disposition → attachment; filename=WorkloadPackage_20180524_180900.wlmpkg

      content-length → 887

      content-type → application/aapkg

      date → Thu, 24 May 2018 12:39:00 GMT

      expires → 0

      pragma → no-cache

      x-frame-options → SAMEORIGIN

    导入队列

    在将队列包成功导出到网络驱动器或Enterprise Control Room计算机路径后,其他授权用户可以使用导入 API 将该包导入到其他Enterprise Control Room

    1. 使用 Post 方法生成使用端点 http(s)://<hostname:port>/v1/authentication 的令牌。以服务器名称/主机名/IP端口号的形式提供Enterprise Control Room实例。

      例如,https://crtestenv.com:82/v1/authentication

    2. 使用 POST 方法并在请求正文中指出凭证的参数。

      参考示例:

      {

      "username":"Tom.Watson",

      "password":"1234567890"

      }

    3. 单击“播放/开始/发送”。
    4. 工作负载导入 API 将使用通过身份验证 API 获取的身份验证令牌。该身份验证令牌必须作为某一标头输入传递给工作负载导入 API。
    5. 提供请求参数 X-AuthorizationContent-Type 作为标头。

      例如:

      "X-Authorization":"authorization token issued by Enterprise Control Room after login",

      "Content-Type":"multipart/form-data"

    6. 现在提供参数 Content-Disposition:form-data; name="upload"; filename="{file name}" 以在请求正文中导入队列包。

      例如:

      Content-Disposition:form-data;

      name="upload"; filename="{WorkloadPackage_20180524_180900.wlmpkg}"

    7. 单击“播放/开始/发送”。
    8. 当响应状态为“200 OK”时,操作成功

    API 响应代码

    Http(s) 状态代码 响应 - 描述 纠正措施
    200 已成功创建包 不适用
    400 请求参数错误 使用有效参数重试
    404 未找到文件 确保Enterprise Control Room中包含该队列
    501 权限错误 确保您具有所需的权限

    审核日志

    当您导出或导入队列时,系统会在Enterprise Control Room审核日志页面中记录审核条目。

    发送反馈