Übersicht über DELETEs

Im Kontext von echten REST-APIs ist ein DELETE eine Endpunktoperation, die eine Ressource löscht. Dazu gehört in der Regel das Entfernen der Ressource aus der zugrunde liegenden Datenbank.

Im Kontext der Cloud-API ist ein DELETE eine System-API-Operation, die eine vorhandene Ressource aus ClaimCenter „entfernt“. Was es bedeutet, die Ressource zu „entfernen“, hängt vom Ressourcentyp ab. Die DELETE-Operation verbindet sich mit dem ClaimCenter-Code, der den Funktionen entspricht, die am ehesten mit dem Löschen verknüpft sind. Dieser Code könnte theoretisch:

Die entsprechende Datenmodellinstanz aus der Betriebsdatenbank löschen.
Die entsprechende Datenmodellinstanz als zurückgezogen markieren.
Die entsprechende Datenmodellinstanz und andere zugehörige Instanzen ändern, um anzugeben, dass die Daten nicht mehr aktiv oder verfügbar sind.

Im Gegensatz zu GET, POST und PATCH gibt es in der Basiskonfiguration nur wenige Endpunkte, die DELETE unterstützen. Dies liegt daran, dass ClaimCenter in den meisten Fällen das Entfernen von Daten nicht unterstützt. Mehrere Geschäftsobjekte können genehmigt, storniert, abgeschlossen, geschlossen, abgelehnt, zurückgewiesen, zurückgezogen, übersprungen oder widerrufen werden. Aber nur wenige können gelöscht werden.

Ein DELETE-Aufruf besteht aus der DELETE-Operation und dem Endpunkt, z. B. DELETE /notes/{noteId}. Ähnlich wie GETs dürfen DELETEs keine Anforderungs-Nutzdaten haben.

Die Antwort auf ein DELETE enthält einen HTTP-Code, der Erfolg oder Fehler angibt. DELETE-Antworten haben keine Antwort-Nutzdaten.

Lernprogramm: Löschen von Notizen

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 werden Sie Aufrufe als Elizabeth Lee (Benutzername elee) senden. In der Basiskonfiguration ist Elizabeth Lee eine Managerin, die über die Berechtigung verfügt, Notizen zu löschen. Als Elizabeth Lee erstellen Sie eine Notiz und eine Abfrage dafür. Anschließend löschen Sie die Notiz und versuchen, sie ein zweites Mal abzufragen.

Schritte des Lernprogramms

Erstellen Sie in Postman eine erste Anforderung durch:
1. Klicken Sie auf das + rechts neben der Registerkarte Launchpad.
2. Geben Sie als Basic Auth-Autorisierung den Benutzer elee und das Kennwort gw an.
Geben Sie den folgenden Aufruf ein, klicken Sie aber noch nicht auf Senden:
1. POST http://localhost:8080/cc/rest/common/v1/activities/cc:20/notes
Geben Sie die Anforderungs-Nutzdaten an.
1. Klicken Sie in der ersten Zeile der Registerkarten (die mit Params beginnt) auf Body.
2. Wählen Sie in der Optionsfeldzeile raw aus.
3. Ändern Sie am Ende der Zeile mit den Optionsfeldern den Wert der Dropdown-Liste von Text in JSON.
4. Kopieren Sie Folgendes in das Textfeld unter den Optionsfeldern.
```
{
  "data":
    {
      "attributes": {
        "body": "API tutorial note to be deleted"
      }
    }
}
```
Klicken Sie auf Senden. Geben Sie in den Antwort-Nutzdaten die ID der Notiz an.
Erstellen einer zweiten Anforderung durch:
1. Klicken Sie auf das + rechts neben der Registerkarte Launchpad.
2. Geben Sie als Basic Auth-Autorisierung den Benutzer elee und das Kennwort gw an.
Stellen Sie sicher, dass die neue Notiz vorhanden ist, indem Sie den folgenden Aufruf eingeben und auf Senden klicken:
1. GET http://localhost:8080/cc/rest/common/v1/notes/<noteID>
Erstellen Sie eine dritte Anforderung durch:
1. Klicken Sie auf das + rechts neben der Registerkarte Launchpad.
2. Geben Sie als Basic Auth-Autorisierung den Benutzer elee und das Kennwort gw an.
Löschen Sie die neue Notiz, indem Sie den folgenden Aufruf eingeben und auf Senden klicken:
1. DELETE http://localhost:8080/cc/rest/common/v1/notes/<noteID>
Stellen Sie sicher, dass die neue Notiz nicht mehr vorhanden ist, indem Sie zur zweiten Registerkarte (die mit dem GET) zurückkehren und ein zweites Mal auf Senden klicken.

Ihre Arbeit überprüfen

Das erste GET (das vor dem DELETE ausgeführt wurde) sollte Details über die Notiz zurückgeben.

Das zweite GET (das nach dem DELETE ausgeführt wurde) sollte eine Fehlermeldung ähnlich der folgenden zurückgeben:

{
    "status": 404,
    "errorCode": "gw.api.rest.exceptions.NotFoundException",
    "userMessage": "No resource was found at path /common/v1/notes/xc:301"
}