Die PATCH-Nutzdatenstruktur

Die Kommunikation zwischen Consumer-Anwendungen und System-APIs ist einfacher zu verwalten, wenn die Informationen in den Nutzdaten einer Standardstruktur folgen. Die System-APIs verfügen über Standardstrukturen sowohl für Anforderungs- als auch für Antwort-Nutzdaten. Die Strukturen werden durch Daten-Envelopes sowie durch Anforderungs- und Antwortschemas definiert. POSTs und PATCHs verwenden Daten-Envelopes, Anforderungsschemas und Antwortschemas auf die gleiche Weise. Weitere Informationen finden Sie unter Standardisierung von Nutzdatenstrukturen.

Entwerfen von Anforderungs-Nutzdaten

Das Entwerfen von Anforderungs-Nutzdaten für einen PATCH ist fast dasselbe wie das Entwerfen von Anforderungs-Nutzdaten für einen POST. Die einzigen Unterschiede sind:

  • Felder, die als requiredForCreate markiert sind, sind für POSTs, aber nicht für PATCHs erforderlich.
  • Felder, die als createOnly markiert sind, sind in POSTs, aber nicht in PATCHs zulässig.

Weitere Informationen zum Entwerfen von Anforderungs-Nutzdaten für POSTs finden Sie unter Entwerfen von Anforderungs-Nutzdaten.