Workflow バージョンのインポート

.flow ファイルをアップロードして現在の Workflow 設定を置き換え、新しいバージョンとして保存できます。

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

リクエストメソッド

POST

リクエストURL

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

リクエスト認証

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

リクエスト

リクエスト例

curl -X POST 'https://api.${endpoint}/v1/workflow/version/import' \ -H 'Authorization: Bearer ${token}' \ -F 'file=@/path/to/workflow.flow' \ -F 'versionDesc=Update workflow nodes'

                      
                      curl -X POST 'https://api.${endpoint}/v1/workflow/version/import' \
  -H 'Authorization: Bearer ${token}' \
  -F 'file=@/path/to/workflow.flow' \
  -F 'versionDesc=Update workflow nodes'

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

リクエストヘッダー

フィールド	タイプ	説明
Authorization	Bearer ${token}	対象 Workflow の API Key を使用して呼び出しを検証します。
Content-Type	multipart/form-data	ファイルアップロードフォーム。

リクエストパラメータ（Form Data）

パラメータ	タイプ	説明	required
file	File	`.flow` ファイル。	true
versionDesc	String	バージョンの説明。	false

レスポンス

レスポンスボディ

{ "code": 0, "message": "OK", "data": { "botId": "workflow-xxxx", "botType": "FLOW_AGENT", "version": "v2", "warning": null } }

                      
                      {
  "code": 0,
  "message": "OK",
  "data": {
    "botId": "workflow-xxxx",
    "botType": "FLOW_AGENT",
    "version": "v2",
    "warning": null
  }
}

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

成功時のレスポンス

フィールド	タイプ	説明
botId	String	対象 Workflow ID。
botType	String	Bot タイプ。
version	String	保存されたバージョン番号。同時に現在のバージョンになります。
warning	String	インポート警告情報。無い場合は null。

エラー時のレスポンス

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

ステータスコード

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