阅读和查看 Automation Anywhere 文档

Automation Anywhere Automation 360

关闭内容

内容

打开内容

请求设备详细信息

  • 已更新:7/10/2020
    • Automation 360 v.x
    • 探索
    • RPA 工作区

请求设备详细信息

使用此 API 检索可用于 bot 部署的设备列表。

先决条件

角色和许可证
您必须以具有无人值守机器人运行人员许可证的用户身份进行身份验证。
  • URL
    http://<your_control_room_url>/v2/devices/list
  • MethodPOST
支持的可筛选参数
id
设备的数字标识符。
  • 字段id
  • 类型整数
{
  "filter": {
    "operator": "eq",
    "value": "7",
    "field": "id"
  }
}
主机名
注册设备的名称。
  • 字段主机名
  • 类型字符串
{
  "filter": {
    "operator": "substring",
    "value": "AA",
    "field": "hostName"
  }
}
userId
与注册设备相关联的用户的唯一数字标识符。
  • 字段userId
  • 类型
{
  "filter": {
    "operator": "eq",
    "value": "13",
    "field": "userId"
  }
}
status
设备的连接状态。
  • 字段状态
  • 类型字符串
{
  "filter": {
     "operator": "eq",
     "value": "CONNECTED",
     "field": "status"
      }
}

此任务请求在主机名参数中具有特定字符串的所有设备和设备特定状态的列表。使用响应中的列表,确定哪些设备已连接且可用于运行 bots

过程

  1. 使用 POST 方法生成身份验证 JSON Web 令牌。将生成的身份验证令牌添加到请求标头。
  2. 选择 POST 方法。
  3. 输入 API 的 URL:
    https://<your_control_room_url>/v2/devices/list
  4. 在请求正文中,添加过滤、排序和分页规则以检索要部署的设备列表。
    例如,此请求主体使用“and”作为运算符,使用设备“状态”和“主机名”作为字段来过滤所需结果。结果将根据“状态”按“降序”排序。
    {
      "sort": [
        {
          "field": "status",
          "direction": "desc"
        }
      ],
      "filter": {
        "operator": "and",
        "operands": [
          {
            "operator": "eq",
            "value": "CONNECTED",
            "field": "status"
          },
          {
            "operator": "substring",
            "value": "win",
            "field": "hostName"
          }
        ]
      },
      "fields": [
        
      ],
      "page": {
        "offset": 0,
        "total": 71,
        "totalFilter": 18,
        "length": 100
      }
    }
  5. 发送请求。
    • 在 REST 客户端中,单击发送
    • 在 Swagger 界面中,单击执行

    响应正文:

    响应返回两个设备的详细信息,这些设备处于“已连接”状态,并且根据请求的筛选条件,设备的主机名称以“win”开头。
    {
      "page": {
        "offset": 0,
        "total": 71,
        "totalFilter": 7
      },
      "list": [{
        "id": "163",
        "type": "ATTENDED_BOT_RUNNER",
        "hostName": "winwlm-2",
        "userId": "",
        "userName": "",
        "status": "CONNECTED",
        "poolName": "",
        "fullyQualifiedHostName": "-",
        "updatedBy": "b2",
        "updatedOn": "2020-07-07T08:24:56.091061Z",
        "botAgentVersion": "12.1"
      }, {
        "id": "162",
        "type": "ATTENDED_BOT_RUNNER",
        "hostName": "winwlm-1",
        "userId": "",
        "userName": "",
        "status": "CONNECTED",
        "poolName": "",
        "fullyQualifiedHostName": "-",
        "updatedBy": "b1",
        "updatedOn": "2020-07-07T08:24:55.982047Z",
        "botAgentVersion": "12.1"
      }
    }

后续步骤

您可以使用在响应中收到的设备 ID 在 Bot Runners 上部署 bots
发送反馈