要求裝置詳細資料

使用此 API 擷取可供 bot 部署的裝置清單。

1. 使用 POST 方法生成身份驗證 JSON Web 令牌。將生成的驗證令牌添加到請求標頭。
   驗證 API
2. 選擇 POST 方法。
3. 輸入 API 的 URL ：

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

4. 在請求主體中，添加過濾、排序和分頁規則以檢索要部署的設備列表。
   例如，此請求主體使用“ 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 接口中，單擊 Execute（執行）。

   響應主體：

   響應返回兩個處於“已連接” 狀態 的設備的詳細信息， 並且主機名 基於請求的過濾器條件以 "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"
     }
   }