自動登録 API の使用

デバイスを自動的に登録し、Control Room API を使用してAuto registrationに接続します。

この API は、Control Roomautoregistration.properties ファイルから取得した汎用 登録トークンを使用して、指定された Control Room URL にデバイスを登録します。 Control Room の URL が autoregistration.properties ファイルに存在しない場合、デバイスを自動登録することはできません。 autoregistration.properties ファイルはローカル システムに存在している必要があります。このファイルは登録が完了した後で削除しないでください。

注: コマンド ラインや API でデバイスを登録するには、AA_DELAY_REGISTRATION_UNTIL_LOGIN MSI パラメーターを設定する必要があります。 このパラメーターは、Bot Agent MSI ファイルまたは autoregistration.properties ファイルで有効にすることができます。 詳細については、「Bot エージェント の一括インストール」を参照してください。 一括インストールのトピックでは、autoregistration.properties ファイルのサンプルも確認できます。

リクエスト

POST http://127.0.0.1:22113/v1/registration/auto
リクエスト 本体:
{
    "url": "https://{controlroom url}",
    "userName": "dpcreator"
}

リクエスト パラメーター

パラメーター タイプ 必須 説明
URL 文字列 はい

Control Room URL を指定して、 デバイスにダウンロードします。
userName 文字列 いいえ

Control Room ユーザーを指定して デバイスをデフォルトのデバイスとして設定。

レスポンス

{
  "result": "REGISTERED",
  "deviceId": "11",
  "crUrl": "control_room_url",
  "userName": "dpcreator"
  "installationType": "SYSTEM_WIDE",
  "crSwitchAllowed": "false",
}

レスポンス パラメーター

パラメーター タイプ 説明
結果 文字列 デバイス登録のステータスです。
deviceId 数字 Bot エージェントがインストールされているデバイスの一意の ID インストールされました。
crUrl 文字列

デバイスが登録される Control Room の URL 自動登録されました。
userName 文字列

デバイスがデフォルトとして関連付けられているユーザー名です。 デバイスにダウンロードします。
installationType 文字列 実行されるインストールのタイプです。
crSwitchAllowed 文字列 デバイスが別の Control Room に登録できるかどうかを示します。
REST API は、HTTP レスポンス コードで各リクエストに応答します。レスポンス コードについては、「API レスポンス コード」を参照してください。