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になります。
レスポンスヘッダーレスポンスヘッダーに含まれるパラメータを定義します。
レスポンスエンドポイントに送信されたリクエストに対する可能なレスポンスを定義します。

このフィールドには次のサブフィールドがあります。

入力フィールド説明
名前レスポンスの名前。例: UnauthorizedまたはCreated
コードレスポンスの種類を識別する、レスポンスに関連付けるHTTPステータスコード。例: Unauthorizedレスポンスは401ステータスコードに関連付けられます。
レスポンス構造レスポンスボディの最も外側の構造を定義します: 単一の Object、またはトップレベル配列。たとえば、Array of objects、Array of strings、Array of integers、Array of numbers、Array of booleans、Array of dates、Array of date-times などです。デフォルトは Object です。
レスポンススキーマResponse structure が Object または Array of objects に設定されている場合にのみ表示されます。レスポンス本文に必要な想定スキーマを定義します。

バイナリコンテンツの処理

マルチパートデータには、画像やPDFファイルなどのバイナリデータが含まれる場合があります。これらのファイルがutf-8エンコーディング形式であることを確認する必要があります。 Workatoレシピの文字列処理はutf-8をサポートしています。

出力 ​

出力フィールド説明
コンテキストAPIリクエストに関するメタデータ。

このフィールドには次のサブフィールドがあります:

出力フィールド説明
呼び出し元ジョブIDリクエストに関連付けられたジョブのID。
呼び出し元レシピIDレシピから呼び出された場合、リクエストを送信したレシピのID。
呼び出し元IPアドレスこのレシピをエンドポイントとして呼び出しているクライアントのIPアドレス。
アクセスプロファイルリクエストの実行に使用されたアクセスプロファイルに関する詳細。
APIクライアントリクエストの実行に使用されたAPIクライアントに関する詳細を含みます。
JWTクレームJWTトークンが使用されている場合にのみ利用可能です。リクエストの認証に使用されたJWTクレームに関する詳細を含みます。
リクエストリクエストのコンテンツタイプと本文に関する詳細を含みます。

このフィールドには次のサブフィールドがあります:

出力フィールド説明
コンテンツタイプリクエストのコンテンツタイプがRawの場合にのみ適用されます。リクエストのContent-Typeヘッダー値。
リクエスト本文(raw)リクエストのコンテンツタイプがRawの場合にのみ適用されます。リクエストの完全なraw本文。
リクエスト本文(JSON)リクエストのコンテンツタイプがJSONの場合にのみ適用されます。 Request body フィールドまたはレガシーの Request schema フィールドで定義されたすべてのフィールドを含む JSON オブジェクト。
リクエスト本文Request body フィールドで定義された各フィールドに対するデータピルを含みます。 Request structure が配列タイプに設定されている場合、このグループはリクエストボディ内の項目リストを表します。
Request parametersレガシグループ。レガシーの Request schema で定義された各フィールドに対するデータピルを含みます。 Request structure が配列タイプに設定されている場合、このグループには、リクエストボディ内の項目に対するループ内で使用する List size データピルおよび List index データピルも含まれます。

追加リソース ​

最終更新日: