要求包含

要求包含は、以下で構成される呼び出しの POST および PATCH の手法です。

  • リソースを作成または変更する単一の親要求
  • 親リソースに関連するリソースを作成または変更する 1 つ以上の子要求

親要求またはいずれかの子要求のどれかが失敗すると、要求全体が失敗します。

多くの場合、親リソースはルートリソースとも呼ばれますルートリソースは、ペイロードの data セクションで指定されます。関連リソースは、ペイロードの included セクションで指定されます。

例えば、呼び出し元では単一の POST /claims を使用して、新規クレーム、そのクレームのクレーム連絡先のセット、そのクレームのインシデントのセット、およびそのクレームのエクスポージャーのセットを作成できます。

要求包含を使用するには、以下に該当する必要があります。

  • ルートリソースで POST または PATCH のエンドポイントが存在する必要がある。
  • このエンドポイントで、子リソースが included セクションの一部となっている必要がある。
  • 子リソースで POST または PATCH のエンドポイントが存在する必要もある。

要求包含の構文は、ルートリソースと包含リソースの関係が「単純な親／子関係」か、「名前付き関係」かによって少し異なります。