阅读和查看 Automation Anywhere 文档

Automation 360

关闭内容

内容

打开内容

请求设备详细信息

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

请求设备详细信息

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

先决条件

角色和许可证
您必须使用 Unattended bot runner license
  • URL
    http://<your_control_room_url>/v2/devices/list
  • 方法POST
支持的可过滤参数
ID
设备的数字标识符。
  • 字段ID
  • 类型整数
{
  "filter": {
    "operator": "eq",
    "value": "7",
    "field": "id"
  }
}
主机名
注册设备的名称。
  • 字段主机名
  • 类型string
{
  "filter": {
    "operator": "substring",
    "value": "AA",
    "field": "hostName"
  }
}
用户身份
与注册设备关联的用户的唯一数字标识符。
  • 字段用户身份
  • 类型long
{
  "filter": {
    "operator": "eq",
    "value": "13",
    "field": "userId"
  }
}
地位
设备的连接状态。
  • 字段地位
  • 类型string
{
  "filter": {
     "operator": "eq",
     "value": "CONNECTED",
     "field": "status"
      }
}

主机名 参数 中具有特定字符串 和设备特定 状态 的所有设备的列表。使用响应中的列表来确定哪些设备已连接并可运行 bots.

过程

  1. 使用 POST 方法生成身份验证 JSON Web Token。将生成的身份验证令牌添加到请求标头。
  2. 选择 POST 方法。
  3. 输入 API 的 URL:
    https://<your_control_room_url>/v2/devices/list
  4. 在请求正文中,添加过滤、排序和分页规则以检索您要部署的设备列表。
    注: 目前不支持请求正文中的 fields当您在请求正文中发送字段名称以限制响应中的字段数量时,它不会按预期工作,而是返回所有字段。
    例如,此请求正文使用“and”作为 运算符 ,设备“status”和“hostname”作为 字段 来过滤所需的结果。结果将根据“状态”按“降序”排序。
    {
      "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 来部署 botsBot Runners.
发送反馈