Workflow バージョン一覧の照会

対象 Workflow のバージョン履歴一覧を照会できます。

本インターフェースは対象 Workflow 自身の API Key で認証を行い、バージョン管理権限を有効化した Workflow のみが呼び出せます。

リクエストメソッド

GET

リクエストURL

https://api.${endpoint}/v1/workflow/version/list

リクエスト認証

詳しくは API 概要の認証方式の説明をご参照ください。対象 Workflow の API Key を token として使用してください。

リクエスト

リクエスト例

curl -X GET 'https://api.${endpoint}/v1/workflow/version/list' \ -H 'Authorization: Bearer ${token}'

                      
                      curl -X GET 'https://api.${endpoint}/v1/workflow/version/list' \
  -H 'Authorization: Bearer ${token}'

このコードブロックをポップアップで表示

リクエストヘッダー

フィールド	タイプ	説明
Authorization	Bearer ${token}	対象 Workflow の API Key を使用して呼び出しを検証します。

リクエストパラメータ

なし。

レスポンス

レスポンスボディ

{ "code": 0, "message": "OK", "data": [ { "id": "bv-xxxx", "bot_id": "workflow-xxxx", "create_time": 1786327712000, "release_time": 1786327812000, "version": "v2", "version_desc": "Update workflow nodes", "version_status": "PUBLISHED", "creator_email": "owner@example.com" } ] }

                      
                      {
  "code": 0,
  "message": "OK",
  "data": [
    {
      "id": "bv-xxxx",
      "bot_id": "workflow-xxxx",
      "create_time": 1786327712000,
      "release_time": 1786327812000,
      "version": "v2",
      "version_desc": "Update workflow nodes",
      "version_status": "PUBLISHED",
      "creator_email": "owner@example.com"
    }
  ]
}

このコードブロックをポップアップで表示

成功時のレスポンス

フィールド	タイプ	説明
id	String	バージョンレコード ID。
bot_id	String	Workflow ID。
create_time	Long	バージョン作成時刻、ミリ秒タイムスタンプ。
release_time	Long	公開時刻、ミリ秒タイムスタンプ。未公開の場合は空。
version	String	バージョン番号。
version_desc	String	バージョンの説明。
version_status	String	バージョンステータス。
creator_email	String	作成者のメールアドレス。

エラー時のレスポンス

フィールド	タイプ	説明
code	int	エラーコード。
message	string	エラー情報。

ステータスコード

ステータスコード	説明
200	成功
401	未認証
403	権限不足、または API Key でバージョン管理権限が有効化されていません
429	リクエストが頻繁すぎます
500	サーバーエラー