変数のリストを取得する

特定のファイルで使用されている文字列、リスト、配列変数を取得するには、GET リクエストを送信します。

前提条件

JSON Web トークン (JWT)
すべての Control Room API には API にアクセスするための JSON Web トークン (JWT) が必要です。認証 API を使用して認証トークンを生成します。
権限
操作を実行するフォルダーの権限が必要です。Control Room インターフェースで Bot の詳細を表示できる場合は、この API を使用できます。

「ロールの Bot 権限」をご覧ください。

注:
  • API をテストするには、Control Room にインストールされた Swagger 定義ファイルを使用します。利用可能な Swagger API は http://<your_control_room_url>/swagger/ で参照できます。
  • また、REST Client を使用してこのタスクを完了することもできます。

手順

  1. リクエスト ヘッダーに認証トークンを追加します。
    注: 認証 API を使用して JSON Web トークンを生成します。
  2. [GET] メソッドを選択します。
  3. この URL で、変数を抽出するファイルの ID と ファイル バージョン を追加します。
    ファイル バージョンは、最新 または プロダクト のいずれかにできます。デフォルト値は「最新」です。
    URL 例:

    http://<your_control_room_url>/v1/repository/file/12/variables/latest

  4. リクエストを送信します。
    • REST Client で [SEND] をクリックします。
    • Swagger インターフェースで [実行] をクリックします。

    レスポンス本文:

    {
  "botVariables": {
    "stringValue": {
      "string": "xyz"
    },
    "listValues": {
      "list": [a, b, c, d]
    }
  }
}
注: また、コマンド ターミナルから REST リクエストを実行することもできます。これは、Curl リクエストの例です。この例は、読みやすいようにフォーマットされています。角括弧内のテキスト <authentication_token> を認証トークンに置き換えます。
curl -X GET "http://<your_control_room_url>/v1/repository/file/12/variables/latest" 
                    -H "accept: application/json" -H "X-Authorization: <authentication_token>"