PATCH のペイロード構造

コンシューマアプリケーションと Cloud API との通信の管理は、ペイロード内の情報が標準的な構造に従っている場合は比較的容易です。Cloud API には、要求ペイロードと応答ペイロードの両方に標準の構造があります。構造はデータエンベロープによって、また要求スキーマと応答スキーマによって定義されます。POST と PATCH では、データエンベロープ、要求スキーマ、および応答スキーマを同じ方法で使用します。詳細については、ペイロード構造の標準化を参照してください。

要求ペイロードの設計

PATCH の要求ペイロードの設計は、POST の要求ペイロードの設計とほぼ同じです。相違点は以下のみです。

  • requiredForCreate のマークが付いたフィールドは、POST では必須ですが、PATCH では必須ではありません。
  • createOnly のマークが付いたフィールドは、POST では許可されますが、PATCH では許可されません。

POST の要求ペイロードの設計の詳細については、要求ペイロードの設計を参照してください。