API platform by Workato - APIリクエストに応答するアクション

APIリクエストに応答アクションは、現在のジョブを終了し、New APIリクエストトリガーで定義されたHTTPレスポンスを送信します。

アクセス要件

APIレシピには、API platform機能へのアクセスが必要です。 Workatoのプラットフォーム＞API platformページにアクセスできない場合は、Customer Success Managerにお問い合わせください。

入力

このアクションのフィールドは、エンドポイントがAPIリクエストに応答する方法を定義します。

入力項目	説明
応答	レスポンスのタイプを定義します。このメニューのオプションは、レシピの新規APIリクエストトリガーで定義されたレスポンスによって決まります。
レスポンスヘッダー	レスポンスで使用されるヘッダーを定義します。レシピのNew APIリクエストトリガーで定義されている場合にのみ存在します。
Response body	レスポンスで使用される本文のスキーマを定義します。レシピのNew APIリクエストトリガーで定義されている場合にのみ存在します。

出力フィールド

説明

コンテキスト

APIリクエストに関するメタデータ。

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

出力フィールド	説明
呼び出し元IPアドレス	このレシピをRESTエンドポイントとして呼び出すクライアントのIPアドレス。
アクセスプロファイル	リクエストの実行に使用されたアクセスプロファイルに関する詳細。
APIクライアント	リクエストの実行に使用されたAPIクライアントに関する詳細を含みます。
JWTクレーム	JWTトークンが使用されている場合にのみ利用可能です。リクエストの認証に使用されたJWTクレームに関する詳細を含みます。
リクエストヘッダー	エンドポイントに対して定義されたリクエストヘッダーに関する詳細。エンドポイントに対して定義された各リクエストヘッダーについて、データピルが作成されます。

Request parameters

エンドポイントのリクエストスキーマに対して定義されたプロパティに関する詳細。各プロパティについて、データピルが作成されます。

Last updated: