API platform by Workato - 新規APIリクエストトリガー
New API requestトリガーは、レシピエンドポイントのリクエストとレスポンスの構造を定義し、APIリクエストを受信するとジョブを作成します。
アクセス要件
APIレシピには、API platform機能へのアクセスが必要です。 Workatoのプラットフォーム>API platformページにアクセスできない場合は、Customer Success Managerにお問い合わせください。
入力
Requestセクションの入力フィールドは、エンドポイントへのAPIリクエストの構造を定義します:
| 入力項目 | 説明 |
|---|---|
| コンテンツタイプ | リクエストのデータ形式を定義します。 application/json、text/plain、またはmultipart/form-dataを選択します。大きな添付ファイル(最大5GB)をアップロードするには、multipart/form-dataを使用します。 |
| リクエストヘッダー | リクエストヘッダーに含める必要があるパラメータを定義します。 |
| パスパラメータ | JSON および Text/XML リクエストについて、エンドポイントパスで受け付けるパラメータを定義します。 |
| クエリパラメーター | JSON および Text/XML リクエストについて、エンドポイントのクエリ文字列で受け付けるパラメータを定義します。 |
| リクエスト構造 | リクエストボディの最も外側の構造を定義します: 単一の Object、またはトップレベル配列。たとえば、Array of objects、Array of strings、Array of integers、Array of numbers、Array of booleans、Array of dates、Array of date-times などです。デフォルトは Object です。 |
| リクエスト本文 | Request structure が Object または Array of objects に設定されていて、レガシーの Request schema が空の場合にのみ表示されます。リクエスト本文に必要な想定スキーマを定義します。これらのフィールド用のデータピルが Request body グループに表示されます。 |
| リクエストスキーマ | 完全にサポートされているレガシーフィールドです。 Request body フィールドが利用可能になる前にリクエストスキーマを定義したレシピに表示されます。リクエスト本文に必要な想定スキーマを定義します。これらのフィールド用のデータピルは Request parameters グループに表示され、非推奨として示されます。このフィールドをクリアして、代わりに Request body フィールドを定義します。 |
Responseセクションの入力フィールドは、エンドポイントが送信するレスポンスの構造を定義します:
| 入力項目 | 説明 | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| コンテンツタイプ | レスポンスのデータ形式を定義します。空白のままにした場合、デフォルトでJSONになります。 | ||||||||||
| レスポンスヘッダー | レスポンスヘッダーに含まれるパラメータを定義します。 | ||||||||||
| レスポンス | エンドポイントに送信されたリクエストに対する可能なレスポンスを定義します。 このフィールドには次のサブフィールドがあります。
|
バイナリコンテンツの処理
マルチパートデータには、画像やPDFファイルなどのバイナリデータが含まれる場合があります。これらのファイルがutf-8エンコーディング形式であることを確認する必要があります。 Workatoレシピの文字列処理はutf-8をサポートしています。
出力
| 出力フィールド | 説明 | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| コンテキスト | APIリクエストに関するメタデータ。 このフィールドには次のサブフィールドがあります:
| ||||||||||||||
| リクエスト | リクエストのコンテンツタイプと本文に関する詳細を含みます。 このフィールドには次のサブフィールドがあります:
| ||||||||||||||
| リクエスト本文 | Request body フィールドで定義された各フィールドに対するデータピルを含みます。 Request structure が配列タイプに設定されている場合、このグループはリクエストボディ内の項目リストを表します。 | ||||||||||||||
| Request parameters | レガシグループ。レガシーの Request schema で定義された各フィールドに対するデータピルを含みます。 Request structure が配列タイプに設定されている場合、このグループには、リクエストボディ内の項目に対するループ内で使用する List size データピルおよび List index データピルも含まれます。 |
追加リソース
最終更新日: