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

この 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"
  }
}

このタスクは、name パラメーターに特定の文字列があり、特定の日付後に変更されたすべてのデバイスのリストをリクエストします。レスポンスに含まれるリストを使用して、接続されているデバイスを特定し、利用可能な Bot を実行します。リスト内のすべてのデバイスは登録された Bot Runner です。

手順

  1. リクエスト ヘッダーに認証トークンを追加します。
    注: 認証 API を使用して JSON Web トークンを生成します。
  2. POST メソッドを選択します。
  3. API の URL (http://<your_control_room_url>/v2/devices/list) を入力します。
  4. リクエスト フィルターを入力して、レスポンスにリストされている登録デバイスの数を制限します。論理演算子「AND」でフィルターをラップすることによって、詳細フィルターを作成できます。 
    {
  "filter": {
    "operator": "and",
    "operands": [
      {
        "operator": "ne",
        "value": "7",
        "field": "id"
      },
      {
        "operator": "substring",
        "value": "ec",
        "field": "hostName"
      }
    ]
  }
}
  5. リクエストを送信します。
    • REST Client で SEND をクリックします。
    • Swagger インターフェースで [実行] をクリックします。

    レスポンス本文:

    レスポンスには、8 つある登録デバイスのうち、フィルター基準を満たす 2 つのデバイスが含まれます。
    {
  "page": {
    "offset": 0,
    "total": 8,
    "totalFilter": 2
  },
  "list": [
    {
      "id": "1",
      "type": "BOT_CREATOR",
      "hostName": "EC2AMAZ-R8AC9KV",
      "userId": "2",
      "userName": "docbotcreator",
      "status": "DISCONNECTED",
      "poolName": "",
      "fullyQualifiedHostName": "EC2AMAZ-R8AC9KV"
    },
    {
      "id": "14",
      "type": "BOT_RUNNER",
      "hostName": "EC2AMAZ-R8AC9KV",
      "userId": "3",
      "userName": "docbotrunner",
      "status": "DISCONNECTED",
      "poolName": "Finance Test Device Pool",
      "fullyQualifiedHostName": "EC2AMAZ-R8AC9KV"
    }
  ]
}

次のステップ

タイプが BOT_RUNNER で ステータス が CONNECTED のデバイスの ID を書き留めます デバイスの ID を書き留めます。デバイス ID および Bot ID は、Bot Runner で Bot を実装するために使用されます。