閱讀及檢閱 Automation Anywhere 文件

Automation Anywhere Automation 360

關閉內容

內容

開啟內容

要求裝置詳細資料

  • 已更新:2020/07/10

    要求裝置詳細資料

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

    先決條件

    角色和許可證
    您必須以 使用者身分驗證、並取得 Unattended bot runner 授權
    • 網址
      http://<your_control_room_url>/v2/devices/list
    • 方法貼文
    支持的可過濾參數
    ID
    設備的數字標識符。
    • 字段ID
    • 類型整數
    {
      "filter": {
        "operator": "eq",
        "value": "7",
        "field": "id"
      }
    }
    主機名稱
    註冊設備的名稱。
    • 字段主機名稱
    • 類型字串
    {
      "filter": {
        "operator": "substring",
        "value": "AA",
        "field": "hostName"
      }
    }
    用戶 ID
    與註冊設備關聯的用戶的唯一數字標識符。
    • 字段用戶 ID
    • 類型
    {
      "filter": {
        "operator": "eq",
        "value": "13",
        "field": "userId"
      }
    }
    狀態
    設備的連接狀態。
    • 字段狀態
    • 類型字串
    {
      "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 ”作爲操作符,設備“ 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"
        }
      }

    後續步驟

    您可以使用響應中收到的設備 ID 在上部署。 bots Bot Runners
    傳送意見反饋