ロボットのバージョンのサブフロー(コマンド)一覧を取得
api.example.com、console.example.com、files.example.comは説明用のアドレスです。実際の環境で指定された API、管理画面、ファイル配布先の URL に置き換えてください。
このAPIは、指定したロボットの公開済みバージョンに含まれるサブフロー(コマンド)の一覧を取得します。そのロボットが一度も公開されていない場合は、現在開発中のバージョンに含まれるサブフローの一覧を返します。
事前操作
1. 認可APIを使用してaccessTokenを取得します。
リクエスト
| 基本 | パラメータ値 | 説明 |
|---|---|---|
| HTTP URL | https://api.example.com/oapi/app/open/queryVersionFlowList | |
| HTTP Method | GET |
リクエストヘッダー
| 基本 | パラメータ値 | 説明 |
|---|---|---|
| Authorization | Bearer {accessToken} | {accessToken}変数は、認可APIが返すaccess Tokenに置き換える必要があります |
リクエストパラメータ
URL Query String形式でパラメータを渡します。
| 名称 | タイプ | 必須 | 説明 |
|---|---|---|---|
| appId | String | はい | ロボットID |
レスポンス
レスポンスデータ構造
| 名称 | タイプ | 説明 |
|---|---|---|
| data | array | 結果データの一覧 |
| ├─ versionId | string | ロボットのバージョンID |
| ├─ name | string | コマンド(サブフロー)の名称 |
| ├─ description | string | コマンドの説明 |
| ├─ helpLink | string | コマンドのヘルプドキュメントのアドレス |
| ├─ icon | string | コマンドのアイコンのアドレス |
| code | integer | 戻り値の結果コードです。200は成功、その他は失敗を示します |
| success | boolean | 呼び出しが成功したかどうかを示します。このフィールドでAPI呼び出しが成功したかどうかを判断できます |
| requestId | string | 調査に使用するリクエストid |
| serverIp | string | 処理を行うサービスのIp |
| msg | string | ステータスコードの説明 |
レスポンスデータの例
| { "data": [ { "versionId": "9c2f1a3e-1234-4a5b-9c1d-0f1e2d3c4b5a", "name": "主流程", "description": "指令描述示例", "helpLink": "", "icon": "https://files.example.com/icon/flow.png" } ], "code": 200, "success": true, "requestId": "2f296259-d953-4939-9701-bc28ac43e002", "serverIp": "10.10.1.21", "msg": null } |
|---|
想定されるエラーコード
| code | 説明 |
|---|---|
| 401 | 認可されていません。accessTokenが無効、または指定されていません。先に認可を完了してaccessTokenを取得する必要があります |
| 80101001 | ロボットが存在しません |
| 80101026 | ロボットのデプロイ情報が存在しません(ロボットがまだ公開されておらず、開発中のバージョンのデプロイ情報もありません) |
使用例
curlの例
| curl --location --request GET 'https://api.example.com/oapi/app/open/queryVersionFlowList?appId={appId}' \ --header 'Authorization: Bearer {accessToken}' |
|---|