Übersicht über POSTs

Ein POST ist eine System-API-Operation, die eine Ressource oder einen Satz zugehöriger Ressourcen in ClaimCenter erstellt. Die POST-Operation wird auch verwendet, um bestimmte Geschäftsprozesse auszuführen, z. B. das Zuweisen einer Aktivität.

Ein POST besteht aus der POST-Operation und dem Endpunkt, z. B. POST /activities/{activityId}/notes, sowie aus Anforderungs-Nutzdaten. Die Anforderungs-Nutzdaten enthalten Daten über die zu erstellende Ressource.

Die Antwort auf ein POST enthält einen HTTP-Code, der Erfolg oder Fehler angibt. Sie enthält auch Antwort-Nutzdaten. Der Inhalt der Antwort-Nutzdaten wird durch das Schema des Endpunkts bestimmt.

  • Bei einem Endpunkt, der zum Erstellen von Daten verwendet wird, enthalten die Antwort-Nutzdaten Daten aus den Anforderungs-Nutzdaten. Sie können auch von ClaimCenter generierte Daten enthalten, z. B. IDs und Zeitstempel.
  • Bei einem Endpunkt, der zum Ausführen einer Geschäftsaktion verwendet wird, sind die Antwort-Nutzdaten eine mit der Geschäftsaktion verbundene Ressource. Dies kann die Ressource sein, auf der die Aktion ausgeführt wurde. Wenn Sie beispielsweise eine Aktivität zuweisen, enthalten die Antwort-Nutzdaten die zugewiesene Aktivität. Es kann sich auch um eine durch die Geschäftsaktion generierte Ressource handeln. Wenn beispielsweise eine Police storniert wird, enthalten die Antwort-Nutzdaten eine JobResponse.

Wenn ein Entwickler eine aufrufende Anwendung so konfiguriert, dass Informationen an eine System-API gesendet werden, muss er die richtige Struktur für die Anforderungs-Nutzdaten ermitteln. Möglicherweise muss er auch Informationen aus den Antwort-Nutzdaten analysieren. Im weiteren Verlauf dieses Themas wird beschrieben, wie Anforderungs-Nutzdaten für Ressourcen strukturiert sind und wie Entwickler Informationen über Anforderungs-Nutzdatenformate erhalten.

POSTs werden auch zur Ausführung von Geschäftsaktionen verwendet. Für diese POST-Typen können Anforderungs-Nutzdaten unnötig, optional oder erforderlich sein. Zum Beispiel:

  • Für ein POST, das eine Aktivität abschließt, sind keine Anforderungs-Nutzdaten erforderlich.
    • Optional können Sie Anforderungs-Nutzdaten bereitstellen, um der abgeschlossenen Aktivität eine Notiz hinzuzufügen.
  • Ein POST, das eine Aktivität zuweist, erfordert Anforderungs-Nutzdaten. Die Nutzdaten geben an, wie die Aktivität zugewiesen wird.