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

Automation 360

コンテンツを閉じる

コンテンツ

コンテンツを開く

デバイスの詳細のリクエスト

  • 更新済み: 2020/07/10
    • Automation 360 v.x
    • 概要
    • RPA Workspace

デバイスの詳細のリクエスト

この API を使用すると、Bot のデプロイに使用できるデバイスのリストを取得することができます。

前提条件

ロールとライセンス
Unattended Bot Runner ライセンスを持つユーザーとして認証する必要があります。
  • URL:
    http://<your_control_room_url>/v2/devices/list
  • メソッド: POST
サポートされているフィルタ可能なパラメーター:
id
デバイスの数値識別子。
  • フィールド: id
  • タイプ: integer
{
  "filter": {
    "operator": "eq",
    "value": "7",
    "field": "id"
  }
}
hostName:
登録済みデバイスの名前。
  • フィールド: hostName:
  • タイプ: string
{
  "filter": {
    "operator": "substring",
    "value": "AA",
    "field": "hostName"
  }
}
userId
登録済みのデバイスに関連付けられているユーザーの一意の数値識別子。
  • フィールド: userId
  • タイプ: long
{
  "filter": {
    "operator": "eq",
    "value": "13",
    "field": "userId"
  }
}
status
デバイスの接続ステータス。
  • フィールド: status
  • タイプ: string
{
  "filter": {
     "operator": "eq",
     "value": "CONNECTED",
     "field": "status"
      }
}

このタスクは、hostname パラメーターに特定の文字列と特定のデバイスの status のあるすべてのデバイスのリストをリクエストします。レスポンスに含まれるリストを使用して、接続されているデバイスを特定し、利用可能な Bot を実行します。

手順

  1. [POST] メソッドを使用して認証 JSON Web トークンを生成します。リクエスト ヘッダーに生成された認証トークンを追加します。
  2. POST メソッドを選択します。
  3. API の URL を入力します。
    https://<your_control_room_url>/v2/devices/list
  4. リクエスト本文に、デプロイするデバイス リストを取得するためのフィルタリング、ソート、改ページのルールを追加します。
    注: リクエスト本文の fields 配列のフィルタ パラメーターは現在サポートされていません。レスポンスのフィールド数を制限するために、リクエスト本文でフィールド名を送信すると、期待通りに動作せず、代わりにすべてのフィールドが返されます。
    たとえば、このリクエスト本文では、operator として「and」、必要な結果をフィルタリングするために field としてデバイスの「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 Client で [SEND] をクリックします。
    • Swagger インターフェースで [実行] をクリックします。

    レスポンス本文:

    レスポンスは、「接続中」status にあり、リクエストされたフィルタ条件に基づいて hostName が「win」で始まる 2 つのデバイスの詳細を返します。
    {
      "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 を使用して、BotBot Runner にデプロイできます。
フィードバックを送る