RESTエンドポイントURLへのファイルのアップロード
REST API呼び出しの一部としてRESTエンドポイントURLにファイルをアップロードできます。
入力としてファイルをREST V2コネクタに渡すには、要求のcontent-typeをmultipart/form-dataまたはbinaryに設定する必要があります。swagger定義でformDataタイプの入力パラメータを使用する場合、ファイル境界がアップロードしたファイルのコンテンツに追加され、ファイルの開始と終了を示します。swagger定義でbinaryタイプの入力パラメータを使用する場合、コンテンツはファイル境界を持たずに生成されます。
fileタイプのformDataパラメータをswaggerの入力パラメータの1つとして定義する必要があります。以下に例を示します。
{ "name":"file",
"in":"formData",
"description":"file to upload",
"required":false,
"type":"file" }
次の図は、サンプルのREST V2オブジェクト階層を示しています。
入力としてファイルを渡すには、次のいずれかの方法を使用します。
- •xxx_FilePath入力フィールドには、ソース内の値として完全なファイルパスを指定します。すべてのファイル形式で使用されます。
- •xxx_FileData入力フィールドには、ソース内のファイルのBase64エンコード値を渡します。.pdf、.jpg、.xls、.docなどのファイル形式で使用されます。Base64エンコード値の長さは65535文字以内である必要があります。
- •xxx_FileData入力フィールドには、ソース内の文字列としてファイル値を渡します。.txt、.JSON、.xmlなどのプレーンテキストファイル形式で使用されます。ファイルサイズは65535文字以内である必要があります。
次の図は、バイナリファイルをアップロードするためのサンプルのSwaggerファイルを示しています。
