Übersicht über PATCHs

Ein PATCH ist eine System-API-Operation, die eine vorhandene Ressource oder einen Satz zugehöriger Ressourcen in ClaimCenter ändert.

Ein PATCH besteht aus der PATCH-Operation und dem Endpunkt, z. B. PATCH /activities/{activityId}, sowie aus Anforderungs-Nutzdaten. Die Anforderungs-Nutzdaten enthalten die Daten, die in der angegebenen Ressource geändert werden müssen.

Die Antwort auf ein PATCH enthält einen HTTP-Code, der Erfolg oder Fehler angibt. Sie enthält auch Antwort-Nutzdaten. Die Standardantwort für ein PATCH besteht aus einem vorbestimmten Satz von Feldern und Ressourcen. Dies kann die durch das PATCH geänderten Daten einschließen oder auch nicht.

Wenn ein Entwickler eine Consumer-Anwendung für PATCH-Informationen für eine System-API konfiguriert, muss er die richtige Struktur für die Anforderungs-Nutzdaten ermitteln. Möglicherweise muss er auch Informationen aus den Antwort-Nutzdaten analysieren.

Die PUT-Operation

Innerhalb der REST-API-Architektur gibt es zwei Operationen, die vorhandene Ressourcen ändern: PATCH und PUT. PATCH wird verwendet, um einen Teil einer vorhandenen Ressource zu ändern (während andere Aspekte davon unverändert bleiben). PUT wird verwendet, um den gesamten Inhalt einer vorhandenen Ressource durch neue Daten zu ersetzen. Die System-APIs unterstützen die PATCH-Operation, nicht jedoch die PUT-Operation. Dies liegt daran, dass nahezu jede Operation, die ein InsuranceSuite-Objekt ändert, nur einen Teil davon ändert, während der Rest des Objekts unverändert bleibt. Dieses Verhalten wird PATCH zugeordnet, nicht jedoch PUT.