Workflow のインポート

.flow ファイルをアップロードして組織配下の Workflow としてインポートできます。

本インターフェースを使用して、.flow ファイルをアップロードし、組織配下の Workflow としてインポートできます。インポートに成功すると API Key が自動的に作成され、デフォルトでバージョン管理が無効になります。

リクエストメソッド

POST

リクエストURL

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

リクエスト認証

アカウントレベルの DevKey / DevSecret による Basic 認証を使用します。呼び出しアカウントに組織 Workflow の作成権限が必要です。

リクエスト

リクエスト例

curl -X POST 'https://api.${endpoint}/v1/org/workflow/import' \ -H 'Authorization: Basic ${BASIC_TOKEN}' \ -F 'file=@/path/to/workflow.flow' \ -F 'org_id=p-xxxx' \ -F 'custom_name=Imported Workflow' \ -F 'enable_api=true'

                      
                      curl -X POST 'https://api.${endpoint}/v1/org/workflow/import' \
  -H 'Authorization: Basic ${BASIC_TOKEN}' \
  -F 'file=@/path/to/workflow.flow' \
  -F 'org_id=p-xxxx' \
  -F 'custom_name=Imported Workflow' \
  -F 'enable_api=true'

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

リクエストヘッダー

フィールド	タイプ	説明
Authorization	Basic ${BASIC_TOKEN}	`DevKey:DevSecret` を Base64 エンコードした Basic Token を使用します。
Content-Type	multipart/form-data	ファイルアップロードフォーム。

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

パラメータ	タイプ	説明	required
file	File	`.flow` ファイル。	true
org_id	String	組織 ID。	true
custom_name	String	インポート後のカスタム Workflow 名称。	false
enable_api	Boolean	API の有効化を試みるかどうか。デフォルトは `true`。プランが API をサポートしない場合でもインポートは成功し、`api_enabled=false` を返します。	false

レスポンス

レスポンス例

{ "code": 0, "message": "OK", "data": { "workflow_id": "workflow-xxxx", "name": "Imported Workflow", "api_key": "app-xxxx", "api_enabled": true, "version_manage_enabled": false, "warning": null } }

                      
                      {
  "code": 0,
  "message": "OK",
  "data": {
    "workflow_id": "workflow-xxxx",
    "name": "Imported Workflow",
    "api_key": "app-xxxx",
    "api_enabled": true,
    "version_manage_enabled": false,
    "warning": null
  }
}

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

成功時のレスポンス

フィールド	タイプ	説明
workflow_id	String	インポート後の Workflow ID。
name	String	Workflow 名称。
api_key	String	自動作成された API Key。一度だけ返されます。
api_enabled	Boolean	API が有効化されているかどうか。
version_manage_enabled	Boolean	バージョン管理を許可するかどうか。インポート時はデフォルトで無効。
warning	String	インポート警告。

エラー時のレスポンス

フィールド	タイプ	説明
code	Integer	エラーコード。
message	String	エラー詳細。

ステータスコード

ステータスコード	説明
200	成功
400	パラメータエラー
401	未認証
403	権限不足
429	リクエストが頻繁すぎます
500	サーバーエラー