Prüfsummen für PATCHs und POSTs für Geschäftsaktionen
Bei Operationen mit Anforderungs-Nutzdaten können Prüfsummen in den Anforderungs-Nutzdaten angegeben werden. Dies gilt für PATCHs und die meisten POSTs, die Geschäftsaktionen ausführen. (Wenn ein POST für eine Geschäftsaktion keine Anforderungs-Nutzdaten zulässt, können Sie weiterhin eine Prüfsumme angeben. Sie müssen dies jedoch im Anforderungs-Header tun. Weitere Informationen finden Sie unter Prüfsummen für DELETEs.)
Die checksum-Eigenschaft ist ein untergeordnetes Element der data-Eigenschaft und ein gleichrangiges Element der attributes-Eigenschaft. Es wird die folgende Syntax verwendet:
"checksum": "<value>"
Die folgenden Nutzdaten gelten beispielsweise für ein PATCH zu einer Aktivität. Die Nutzdaten geben einen neuen Attributwert (der priority auf dringend setzt) und einen Prüfsummenwert (2) an.
{
"data": {
"attributes": {
"priority": {
"code": "urgent"
}
},
"checksum": "2"
}
}
Prüfsummen können für die Stammressource und für jede eingeschlossene Ressource angegeben werden. Für die Angabe einer Prüfsumme für eine Ressource müssen Sie keine Prüfsummen für die anderen angeben. Zum Beispiel:
- Sie können eine Prüfsumme nur für die Stammressource angeben.
- Sie können eine Prüfsumme nur für eine der eingeschlossenen Ressourcen angeben.
- Sie können eine Prüfsumme für die Stammressource und einige der eingeschlossenen Ressourcen angeben, aber nicht für alle eingeschlossenen Ressourcen.
Lernprogramm: PATCH einer Aktivität mit Prüfsummen
In diesem Lernprogramm wird davon ausgegangen, dass Sie Postman in Ihrer Umgebung mit dem korrekten Beispieldatensatz eingerichtet haben. Weitere Informationen finden Sie unter Lernprogramm: Einrichten Ihrer Postman-Umgebung.
In diesem Tutorial versuchen Sie, eine Aktivität zweimal PATCH-fähig zu machen. Beide PATCHs enthalten einen Prüfsummenwert. Der erste PATCH ist erfolgreich, das zweite schlägt fehl.
Schritte des Lernprogramms
- Starten Sie in Postman eine neue Anforderung:
- Klicken Sie auf das + rechts neben der Registerkarte Launchpad.
- Geben Sie als Basic Auth-Autorisierung den Benutzer
aapplegateund das Kennwortgwan.
- Fragen Sie alle Aktivitäten ab, indem Sie den folgenden Aufruf eingeben und auf Senden klicken:
- GET
http://localhost:8080/cc/rest/common/v1/activities
- GET
- Notieren Sie sich die ID, den Betreff und die Prüfsumme der ersten Aktivität, die in den Antwort-Nutzdaten zurückgegeben wird. (Diese Werte werden in späteren Schritten als "<ActivityID>", "<originalSubject>" und "<originalChecksum>" bezeichnet.)
- Eine zweite Anforderung starten:
- Klicken Sie auf das + rechts neben der Registerkarte Launchpad.
- Geben Sie als Basic Auth-Autorisierung den Benutzer
aapplegateund das Kennwortgwan.
- Geben Sie den folgenden Aufruf ein, klicken Sie aber noch nicht auf Senden:
- PATCH
http://localhost:8080/cc/rest/common/v1/activities/<ActivityID>
- PATCH
- Geben Sie die Anforderungs-Nutzdaten an.
- Klicken Sie in der ersten Zeile der Registerkarten (die mit Params beginnt) auf
Body. - Wählen Sie in der Optionsfeldzeile raw aus.
- Ändern Sie am Ende der Zeile mit den Optionsfeldern den Wert der Dropdown-Liste von Text in JSON.
- Kopieren Sie Folgendes in das Textfeld unter den Optionsfeldern. Geben Sie für Betreff den ursprünglichen Betreff mit einem zusätzlichen "
-1" an.{ "data": { "attributes": { "subject" : "<originalSubject>-1" } }, "checksum": "<originalChecksum>" }
- Klicken Sie in der ersten Zeile der Registerkarten (die mit Params beginnt) auf
- Klicken Sie auf Senden. Der Prüfsummenwert in den Nutzdaten entspricht dem Prüfsummenwert für die in ClaimCenter gespeicherte Aktivität. Daher sollte der PATCH erfolgreich sein und die Antwort-Nutzdaten unter den Anforderungs-Nutzdaten erscheinen.
- Klicken Sie ein zweites Mal auf Senden. Nun stimmt der Prüfsummenwert in den Nutzdaten nicht mit dem Prüfsummenwert für die von ClaimCenter berechnete Aktivität überein. Daher ist das zweite PATCH nicht erfolgreich und es wird eine Fehlermeldung angezeigt.
Lernprogramm: Eine Aktivität mithilfe von Prüfsummen zuweisen
In diesem Lernprogramm wird davon ausgegangen, dass Sie Postman in Ihrer Umgebung mit dem korrekten Beispieldatensatz eingerichtet haben. Weitere Informationen finden Sie unter Lernprogramm: Einrichten Ihrer Postman-Umgebung.
In diesem Tutorial versuchen Sie, eine Geschäftsaktion zweimal auszuführen (eine Aktivität zuzuweisen). Beide Versuche beinhalten einen Prüfsummenwert. Der erste Versuch wird erfolgreich sein, und der zweite wird scheitern.
Schritte des Lernprogramms
- Abfragen aller offenen Aktivitäten in Postman:
- Klicken Sie auf das + rechts neben der Registerkarte Launchpad.
- Geben Sie als Basic Auth-Autorisierung den Benutzer
aapplegateund das Kennwortgwan. - Geben Sie den folgenden Aufruf ein und klicken Sie dann auf Senden:
- GET
http://localhost:8080/cc/rest/common/v1/activities?filter=status:ne:complete
- GET
- Notieren Sie sich die ID und die Prüfsumme der ersten Aktivität, die in den Antwort-Nutzdaten zurückgegeben wird. (Diese Werte werden in späteren Schritten als "<ActivityID>" und "<originalChecksum>" bezeichnet.)
- Eine zweite Anforderung starten:
- Klicken Sie auf das + rechts neben der Registerkarte Launchpad.
- Geben Sie als Basic Auth-Autorisierung den Benutzer
aapplegateund das Kennwortgwan.
- Geben Sie den folgenden Aufruf ein, klicken Sie aber noch nicht auf Senden:
- PATCH
http://localhost:8080/cc/rest/common/v1/activities/<ActivityID>/assign
- PATCH
- Der POST-Endpunkt
/{activityId}/assignerfordert Anforderungs-Nutzdaten, die angeben, wie die Zuweisung durchzuführen ist. Geben Sie die Anforderungs-Nutzdaten an.- Klicken Sie in der ersten Zeile der Registerkarten (die mit Params beginnt) auf
Body. - Wählen Sie in der Optionsfeldzeile raw aus.
- Ändern Sie am Ende der Zeile mit den Optionsfeldern den Wert der Dropdown-Liste von Text in JSON.
- Kopieren Sie Folgendes in das Textfeld unter den Optionsfeldern. Geben Sie als Betreff den ursprünglichen Betreff mit einem zusätzlichen "-1" an.
{ "data": { "attributes": { "autoAssign": true }, "checksum": "<originalChecksum>" } }
- Klicken Sie in der ersten Zeile der Registerkarten (die mit Params beginnt) auf
- Klicken Sie auf Senden. Der Prüfsummenwert in den Nutzdaten entspricht dem Prüfsummenwert für die in ClaimCenter gespeicherte Aktivität. Daher sollte der POST
/assignerfolgreich sein und die Antwort-Nutzdaten sollten unterhalb der Anforderungs-Nutzdaten erscheinen. - Klicken Sie ein zweites Mal auf Senden. Nun stimmt der Prüfsummenwert in den Nutzdaten nicht mit dem Prüfsummenwert für die von ClaimCenter berechnete Aktivität überein. (Der erfolgreiche POST
/assignaus dem vorherigen Schritt hat den Prüfsummenwert geändert.) Der zweite POST/assignist nicht erfolgreich, und es wird eine Fehlermeldung angezeigt.