【廃止】ロボットのメインフローのパラメータ構造を取得するAPI
この記事の内容
【廃止】ロボットのメインフローのパラメータ構造を取得
api.example.com、console.example.com、files.example.comは説明用のアドレスです。実際の環境で指定された API、管理画面、ファイル配布先の URL に置き換えてください。
説明
このAPIの使用は推奨されなくなりました。ロボットのバージョン詳細を取得するAPIに切り替えてください。
事前操作
認証APIを使用してaccessTokenを取得し、対応するヘッダーに入力する必要があります。
説明:このAPIで取得できるのは、バージョンを公開したことがあるロボットのみです。
テンプレート
postManテンプレート
apiロボットのメインフローのパラメータ構造を取得.json(右ボタンをクリックして「名前を付けて保存」)
javaテンプレート
リクエストモデル:
なし
レスポンスモデル:
RobotParamInfo.java(右ボタンをクリックして「名前を付けて保存」)
RobotParamOpenApiBO.java(右ボタンをクリックして「名前を付けて保存」)
リクエスト
| 基本 | 説明 | |
|---|---|---|
| HTTP URL | https://api.example.com/oapi/robot/v2/queryRobotParam | 専用クラウドを利用する企業は、専用クラウドのアドレスを使用してください |
| HTTP Method | GET |
リクエストヘッダー
| 基本 | 説明 | |
|---|---|---|
| Authorization | Bearer {accessToken} | accessToken変数は、認証APIが返すaccess Tokenに置き換える必要があります |
リクエストフォーム
| 名称 | タイプ | 説明 | 必須 | 説明 |
|---|---|---|---|---|
| robotUuid | string | ロボットのuuid | いいえ | |
| accurateRobotName | string | 完全一致で検索するロボットの名称 | いいえ | このパラメータはロボットの名称を完全一致で検索します。あいまい検索には対応していません |
リクエスト例
ロボットのuuidを指定して、ロボットのメインフローのパラメータ構造を取得します。
https://api.example.com/oapi/robot/v2/queryRobotParam?robotUuid=xxxxx
ロボットの正確な名称を指定して、ロボットのメインフローのパラメータ構造を取得します。
https://api.example.com/oapi/robot/v2/queryRobotParam?accurateRobotName=xxx
レスポンス
レスポンスボディ
| 名称 | タイプ | 必須 | 説明 |
|---|---|---|---|
| code | int | はい | ステータスコードです。200は成功、200以外は失敗を示します。参照:ステータスコードの説明 |
| success | boolean | はい | 呼び出しが成功したかどうかを示します。このフィールドでAPI呼び出しが成功したかどうかを判断できます |
| msg | string | はい | ステータスコードの説明 |
| data | array | はい | レスポンスデータ |
| ∟ inputParams | array | いいえ | 入力パラメータ |
| ∟ name | string | はい | パラメータ名 |
| ∟ direction | string | はい | 入力パラメータ・出力パラメータ |
| ∟ type | string | はい | パラメータタイプです。str、float、fileなどの5種類があります |
| ∟ value | string | はい | パラメータ値 |
| ∟ description | string | はい | パラメータの説明 |
| ∟ kind | string | はい | kindはクライアント側の定義の1つで、現在は不要です。文字列に対応するタイプはTextです |
| ∟ outputParams | array | 出力パラメータも上記と同じです | |
| ∟ 同上 |
レスポンスボディの例
{
"data": {
"inputParams": [
{
"name": "input_str_variable",
"direction": "In",
"type": "str",
"value": "",
"description": "",
"kind": "Text"
},
{
"name": "input_float_variable",
"direction": "In",
"type": "float",
"value": "0.0",
"description": "",
"kind": "Expression"
},
{
"name": "input_bool_variable",
"direction": "In",
"type": "bool",
"value": "False",
"description": "",
"kind": "Expression"
},
{
"name": "input_file_variable",
"direction": "In",
"type": "file",
"value": "",
"description": "",
"kind": "Text"
}
],
"outputParams": [
{
"name": "input_int_variable",
"direction": "Out",
"type": "int",
"value": "0",
"description": "",
"kind": "Expression"
}
]
},
"code": 200,
"success": true,
"requestId": "7484425d-2525-4b58-aacf-50f205a603fd"
}
エラーが発生した場合は、ステータスコードの説明に移動してください。