Automation Anywhere ドキュメントを読んで確認する

Automation 360

コンテンツを閉じる

コンテンツ

コンテンツを開く

ID ごとのデバイス プールの詳細を取得する

  • 更新済み: 2021/01/29
    • Automation 360 v.x
    • 概要
    • RPA Workspace

ID ごとのデバイス プールの詳細を取得する

特定のデバイス プールの詳細を数値識別子 (ID) で取得します。

前提条件

注: Community EditionControl Room APIs を表示できますが、API 機能は制限されています。API のすべての機能にアクセスするには、Automation 360 のライセンス版が必要です。

この API を使用するには、以下が必要です。

  • すべてのデバイスを表示およびマネージ。その他のユーザーによるデバイス登録を含め、すべてのデバイスを表示および管理します。
  • すべての API 呼び出しは、リクエスト ヘッダーに認証トークンを含める必要があります。認証 API を使用して JSON Web トークンを生成します。「認証 API」を参照してください。
  • デバイス プール ID: 詳細を取得するデバイス プールの一意の数値識別子。

このタスクは、Control Room で特定のデバイス プールを検索します。API は、URL 文字列の一部としてデバイス プール {id} を渡します。リクエスト本文は必要ありません。

手順

  1. リクエスト ヘッダーに認証トークンを追加します。
  2. GET メソッドとエンドポイント URL を使用します。 <your_control_room_url>/v2/devices/pools/{id}
    URL にデバイス プール ID を入力します。
    この例では、デバイス プール ID は 27 です。
    https://<your_control_room_url>/v2/devices/pools/27
  3. リクエストを送信します。
    リクエストが成功すると、渡されたデバイス プール ID に関連するすべての詳細がレスポンス本文に返されます。
    この例では、デバイス プール ID 27 に関連付けられた名前、自動化スキーム、ステータス、Bot Runner、所有者、コンシューマがレスポンス本文に返されます。
    レスポンス本文:
    {
      "id": "27",
      "name": "finance-device-pool",
      "description": "Finance department device pool",
      "automationScheme": "ROUND_ROBIN",
      "status": "CONNECTED",
      "timeSlice": "5",
      "timeSliceUnit": "MINUTES",
      "deviceIds": [
        "10",
        "23",
        "41"
      ],
      "ownerIds": [
        "48"
      ],
      "consumerIds": [],
      "detailedStatus": "ALL_DISCONNECTED",
      "updatedBy": "48",
      "updatedOn": "2020-04-27T14:29:05.655896Z",
      "createdBy": "48",
      "createdOn": "2020-04-25T10:46:44.642586Z",
      "tenantUuid": "c0a8f10a-717f-130b-8171-7f4762280000",
      "tenantId": "4"
    }
表示されたデバイス プールの詳細を見て、それが Bot デプロイの要件を満たすかどうかを判断します。レスポンスの一部のフィールドは、その他の API への入力として使用されます。
これらの詳細を評価します。
id
id は、Control Room でこのデバイス プールを一意に特定します。この ID を、Bot デプロイ用の poolIds の入力として使用します。

Bot をデプロイ

name
これは、デバイス プールのユーザー定義名です。デバイス プール タスクのリストのフィルタを使用して、デバイス プール name をフィルタリングします。

デバイス プール API のリスト

deviceIds
このデバイス プールの一部である Bot Runner デバイスの一意の数値 ID のリスト。
ownerIds
このデバイス プールの所有者の ID。デバイス プールの所有者は、デバイス プールを表示、編集、削除できます。
consumerIds
自動化の実行中にこのデバイスを表示できるユーザーの ID。

REST API は、HTTP レスポンス コードで各リクエストに応答します。 レスポンス コードについては、「API レスポンス コード」を参照してください。

フィードバックを送る