PATCH への応答

PATCH の操作に成功するたびに、応答ペイロードを含む応答オブジェクトが生成されます。返されるデフォルトフィールドや、クエリパラメータが指定されているかどうかに応じて、応答ペイロードには、PATCH で変更された値が含まれる場合も、含まれない場合もあります。

要求スキーマと同様に、応答スキーマも、特定のパターンに従って、データエンベロープを使用してリソーススキーマをラップします。多数のインスタンスで、要求スキーマと応答スキーマが一致します。

Null 値を含むフィールドの省略

GET や POST と同様に、PATCH の応答ペイロードにも、Null 以外の値を持つフィールドのみが含まれます。Null 値を含むフィールドは、応答ペイロードから省略されます。

あるフィールドが応答ペイロードにあると予想されているのに失われている場合、その理由はたいてい、その値が Null だったためです。

PATCH で fields クエリパラメータを使用して、応答ペイロードに表示されるフィールドを制御できます。例えば、以下では要求ペイロードに基づいて、アクティビティ xc:20 の備考・経緯の PATCH を行います。応答ペイロードにはデフォルトのフィールドがあります。

PATCH /activities/xc:20/notes

以下もまた、要求ペイロードに基づいて、アクティビティ xc:20 の備考・経緯の PATCH を行います。ただし、応答ペイロードには id フィールドのみが含まれます。

POST /activities/xc:20/notes?fields=id