ロボットの公開バージョンの詳細を照会(パラメータを含む)

この記事の内容
  1. 事前操作
  2. リクエスト
  3. リクエストヘッダー
  4. リクエストパラメータ
  5. レスポンス
  6. レスポンスのデータ構造
  7. レスポンスデータの例
  8. 発生する可能性のあるエラーコード
  9. 使用例
  10. curlの例

api.example.com、console.example.com、files.example.com は説明用のアドレスです。実際の環境で指定された API、管理画面、ファイル配布先の URL に置き換えてください。

このAPIは、指定したロボットの現在公開されている(リリース済みの)バージョンの詳細情報を照会するために使用します。そのバージョンに設定されているフローの入力/出力パラメータも含まれます。

事前操作

1.     認証APIを使用してaccessTokenを取得します。

リクエスト

基本 パラメータ値 説明
HTTP URL https://api.example.com/oapi/app/open/query/appOnlineDetailWithParam
HTTP Method GET

リクエストヘッダー

基本 パラメータ値 説明
Authorization Bearer {accessToken} {accessToken}変数は、認証APIが返すaccess Tokenに置き換える必要があります

リクエストパラメータ

URLクエリ文字列でパラメータを渡します。

名称 タイプ 必須かどうか 説明
appId String はい ロボットID

レスポンス

レスポンスのデータ構造

名称 タイプ 説明
data object 結果データ
├─ appId string ロボットID
├─ appName string ロボット名(現在の公開バージョンの名称)
├─ appType string ロボットのタイプ
├─ publishVersion string 公開(リリース)バージョン番号
├─ firstPublish boolean 初回リリースかどうか
├─ publishUserId string リリースしたユーザーのID
├─ publishAccount string リリースしたユーザーのアカウント
├─ publishTime string リリース(公開)日時
├─ flowParams array フローの入力/出力パラメータの定義一覧
├─ name string パラメータ名
├─ direction string パラメータの方向:入力パラメータ/出力パラメータ
├─ type string パラメータタイプ(str、float、fileなど)
├─ value string パラメータ値
├─ description string パラメータの説明
├─ kind string クライアントのパラメータ種別を示す識別子です。現時点では考慮する必要はありません
├─ uiTags string 画面のタグ
├─ terminalTags string 端末のタグです。win:Windowsシステムで使用可能
├─ extraInfo string 拡張情報
code integer 戻り値の結果コードです。200は成功、その他は失敗を示します
success boolean 呼び出しが成功したかどうかを示します。このフィールドでAPI呼び出しの成否を判断できます
requestId string 問題の調査に使用するリクエストID
serverIp string 処理を行うサービスのIP
msg string ステータスコードの説明

レスポンスデータの例

{
    "data": {
        "appId": "107f0f23-3584-4b1b-8665-443605722f95",
        "appName": "kkkkk",
        "appType": "app",
        "publishVersion": "3",
        "firstPublish": false,
        "publishUserId": "c8d9647f-1435-4b5f-bd64-b5d4613e5283",
        "publishAccount": "ceshiz@csqy1",
        "publishTime": "2024-05-08 13:50:24",
        "flowParams": [
            {
                "name": "inputParam1",
                "direction": "input",
                "type": "str",
                "value": "",
                "description": "输入参数示例",
                "kind": ""
            }
        ],
        "uiTags": "",
        "terminalTags": "win",
        "extraInfo": ""
    },
    "code": 200,
    "success": true,
    "requestId": "2f296259-d953-4939-9701-bc28ac43e002",
    "serverIp": "10.10.1.21",
    "msg": null
}

発生する可能性のあるエラーコード

code 説明
401 未認証です。accessTokenが無効であるか、指定されていません。先に認証を完了してaccessTokenを取得する必要があります
80101001 ロボットが存在しません
80101050 ロボットがリリースされていません(公開バージョンがありません)
80101002 このロボットのバージョンが存在しません

使用例

curlの例

curl --location --request GET 'https://api.example.com/oapi/app/open/query/appOnlineDetailWithParam?appId={appId}' \
--header 'Authorization: Bearer {accessToken}'
OpenAPIの記事一覧ページの先頭へ ↑