請求設備詳細信息

使用此 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.

程序

使用 POST 方法生成身份驗證 JSON Web Token。將生成的身份驗證令牌添加到請求標頭。
身份驗證 API
選取 POST 方法。

輸入 API 的 URL：

https://<your_control_room_url>/v2/devices/list

在請求正文中，添加過濾、排序和分頁規則以檢索您要部署的設備列表。

註: 目前不支持請求正文中的 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
  }
}

傳送要求。

在 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 來部署 bots 上 Bot Runners.

Automation 360