ロボットの過去のバージョン一覧を照会

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

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

このAPIは、指定したロボットの過去のバージョン一覧をページ単位で照会するために使用します。各バージョンのステータス、リリースログ、botパッケージのダウンロードアドレスなどの情報が含まれます。

事前操作

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

リクエスト

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

リクエストヘッダー

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

リクエストパラメータ

JSON形式のリクエストボディ(Body)としてパラメータを渡します。

名称 タイプ 必須かどうか 説明
appId String はい ロボットID
needBotUrl Boolean いいえ (このAPIでは現在このフィールドを使用していません。値を渡すかどうかにかかわらず、常にbotパッケージのダウンロードアドレスを返します。同じリクエスト構造を共有する他のAPIとの互換性を維持するためにのみ残されています)
pageDTO Object いいえ ページングパラメータです。渡さない場合はデフォルト値を使用します
├─ page Integer いいえ 現在のページ番号です。デフォルトは1です
├─ size Integer いいえ 1ページあたりの件数です。デフォルトは10です
├─ needCount Boolean いいえ (このAPIでは現在このフィールドを使用していません。ページ単位の照会では、常に総件数を集計しません)

説明:appIdが空の場合、APIは直ちにパラメータ検証の失敗(code=400)を返します。

レスポンス

レスポンスのデータ構造

名称 タイプ 説明
data array 結果データの一覧です。バージョンの作成日時の降順で並びます
├─ versionId string バージョンID
├─ versionName string バージョン名
├─ createTime string 作成日時
├─ updateTime string 更新日時
├─ modifierUserName string 変更者のアカウント
├─ creator string 作成者のユーザーID
├─ modifier string 変更者のユーザーID
├─ versionLog string バージョンのリリースログ
├─ versionStatus string バージョンのステータス:d(開発中)、a(審査中)、n(却下)、sn(システムによる却下)、p(リリース済み)
├─ version string ロボットのバージョン番号
├─ isOnlineVersion boolean 公開バージョンかどうか
├─ nixRemark string 却下理由
├─ botUrl string botパッケージのアドレス
├─ botDownloadUrl string botパッケージのダウンロードアドレス
code integer 戻り値の結果コードです。200は成功、その他は失敗を示します
success boolean 呼び出しが成功したかどうかを示します。このフィールドでAPI呼び出しの成否を判断できます
requestId string 問題の調査に使用するリクエストID
serverIp string 処理を行うサービスのIP
msg string ステータスコードの説明

説明:このAPIは、ページングの集計情報(総件数/総ページ数など)を返しません。ロボットが存在しない場合、または過去のバージョンがない場合は、エラーを報告せず、dataに空の配列[]を返します。

レスポンスデータの例

{
    "data": [
        {
            "versionId": "9c2f1a3e-1234-4a5b-9c1d-0f1e2d3c4b5a",
            "versionName": "kkkkk",
            "createTime": "2024-05-08 13:49:13",
            "updateTime": "2024-05-08 13:50:24",
            "modifierUserName": "ceshiz@csqy1",
            "creator": "c8d9647f-1435-4b5f-bd64-b5d4613e5283",
            "modifier": "c8d9647f-1435-4b5f-bd64-b5d4613e5283",
            "versionLog": "首次发布",
            "versionStatus": "p",
            "version": "3",
            "isOnlineVersion": true,
            "nixRemark": "",
            "botUrl": "",
            "botDownloadUrl": "https://files.example.com/bot/xxx.zip"
        }
    ],
    "code": 200,
    "success": true,
    "requestId": "2f296259-d953-4939-9701-bc28ac43e002",
    "serverIp": "10.10.1.21",
    "msg": null
}

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

code 説明
401 未認証です。accessTokenが無効であるか、指定されていません。先に認証を完了してaccessTokenを取得する必要があります
400 appIdが空である場合など、パラメータの検証に失敗しました

使用例

curlの例

curl --location --request POST 'https://api.example.com/oapi/app/open/historyVersionList' \
--header 'Authorization: Bearer {accessToken}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "appId": "{appId}",
    "pageDTO": {
        "page": 1,
        "size": 10
    }
}'
OpenAPIの記事一覧ページの先頭へ ↑