API レシピ - API リクエストに対する応答アクション

このアクションを使用すると、レシピ内の特定のアクションに対して、API レシピのエンドポイントが、どのように応答するかを定義できます。

このアクションを使用する際は、次の点に注意してください。

このアクションによりレシピのジョブは終了します。 このアクションが正常に実行された時点で、現在のジョブは終了します。これより後のステップは、すべて無視されます。
アクションのデータは HTTP レスポンスの形で返されます。

要件

このアクションを使用するには、以下のことが必要になります。

API プラットフォーム機能を利用できる。 このオプションが [Tools] メニューに表示されない場合は、カスタマーサクセスマネージャーまでお問い合わせください。

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

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

項目

説明

Context

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

この項目には、以下の補足項目もあります。

項目	説明
Calling IP address	このレシピを REST エンドポイントとして呼び出しているクライアントの IP アドレス。
Access profile	リクエストの実行に使用されたアクセスプロファイルに関する詳細。
API client	リクエストの実行に使用された API クライアントに関する詳細が含まれます。
JWT claims	JWT トークンが使用されている場合にのみ使用できます。リクエストの認証に使用された JWT クレームに関する詳細が含まれます。
Request headers	エンドポイントに対して定義されているリクエストヘッダーに関する詳細です。エンドポイントに定義されるリクエストヘッダーごとにデータピルが作成されます。

Request parameters

エンドポイントの要求スキーマに対して定義されているプロパティに関する詳細です。プロパティごとにデータピルが作成されます。

Last updated: