Workflow インポートファイルの事前チェック

.flow ファイルがインポート可能かどうかを事前チェックできます。業務リソースには書き込みません。

本インターフェースを使用して、.flow ファイルがインポート可能かどうかを事前チェックできます。事前チェックはファイルの解析とセキュリティスキャンのみを行い、Workflow、API Key、データグループ、プラグイン関係は書き込みません。

リクエストメソッド

POST

リクエストURL

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

リクエスト認証

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

リクエスト

リクエスト例

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

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

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

リクエストヘッダー

フィールド	タイプ	説明
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

レスポンス

レスポンス例

{ "code": 0, "message": "OK", "data": { "valid": true, "error_message": null, "export_type": "WORKFLOW", "bot_type": "WORKFLOW", "name": "Imported Workflow", "logo": "https://cdn.example.com/workflow.png", "introduction": "Workflow introduction", "format_version": "1.0" } }

                      
                      {
  "code": 0,
  "message": "OK",
  "data": {
    "valid": true,
    "error_message": null,
    "export_type": "WORKFLOW",
    "bot_type": "WORKFLOW",
    "name": "Imported Workflow",
    "logo": "https://cdn.example.com/workflow.png",
    "introduction": "Workflow introduction",
    "format_version": "1.0"
  }
}

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

成功時のレスポンス

フィールド	タイプ	説明
valid	Boolean	ファイルがインポート可能かどうか。
error_message	String	インポート不可の場合のエラー情報。
export_type	String	エクスポートファイルのタイプ。
bot_type	String	Bot タイプ。
name	String	ファイル内のリソース名称。
logo	String	アイコン URL。
introduction	String	紹介文。
format_version	String	ファイルフォーマットのバージョン。

エラー時のレスポンス

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

ステータスコード

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