Antworten auf ein PATCH
Bei jedem erfolgreichen PATCH wird ein Antwortobjekt mit Antwort-Nutzdaten generiert. Abhängig von den zurückgegebenen Standardfeldern und davon, ob Abfrageparameter angegeben wurden, können die Antwort-Nutzdaten die durch das PATCH geänderten Werte einschließen oder auch nicht.
Ähnlich wie Anforderungsschemas folgen Antwortschemas bestimmten Mustern, um das Ressourcenschema mit Daten-Envelopes zu umschließen. In vielen Fällen stimmen das Anforderungs- und das Antwortschema überein.
Felder mit null-Werten werden ausgelassen
Ähnlich wie GETs und POSTs enthalten die Antwort-Nutzdaten für PATCHs nur Felder, deren Werte ungleich null sind. Felder mit null-Werten werden bei den Antwort-Nutzdaten ausgelassen.
Wenn ein bestimmtes Feld in den Antwort-Nutzdaten erwartet wird, aber fehlt, liegt dies häufig daran, dass der Wert null war.
PATCHs und Abfrageparameter
Sie können den Abfrageparameter fields mit einem PATCH verwenden, um die Felder zu steuern, die in den Antwort-Nutzdaten angezeigt werden. Im Folgenden wird beispielsweise eine Notiz für die Aktivität xc:20 basierend auf den Anforderungs-Nutzdaten gePATCHt. Die Antwort-Nutzdaten haben die Standardfelder.
PATCH /activities/xc:20/notes
Im Folgenden wird auch eine Notiz für die Aktivität xc:20 basierend auf den Anforderungs-Nutzdaten gePATCHt. Die Antwort-Nutzdaten enthalten jedoch nur das Feld id.
POST /activities/xc:20/notes?fields=id