Endpunkt - Datensatz löschen

1. Klicken Sie auf (Neuen Endpunkt erstellen).

   Sie gelangen auf den Dialog-Schritt "Allgemein".

   

   Name

   Erfassen Sie hier einen Namen für den Endpunkt.

   Der Name muss eindeutig sein, mindestens aus zwei Zeichen bestehen und mit einem Buchstaben beginnen. Erlaubt sind dabei nur alphanumerische Zeichen, Bindestriche, Unterstriche und Punkte.

   Beschreibung

   Erfassen Sie hier eine Beschreibung für den Endpunkt. Mehrzeilige Texte sind möglich.

2. Klicken Sie auf "Datengruppen-Endpunkt".

3. Klicken Sie auf "Weiter".

   Sie gelangen auf den Dialog-Schritt "Datengruppenauswahl".

Endpunkt

Hier wird die Methode des Endpunkts und der fixe Teil des Endpunktpfads angezeigt.

Aktion

Wählen Sie "Datensatz löschen" aus.

Im oberen Bereich des Fensters wird unterhalb von "Endpunkt" die Methode DELETE und der erste Teil des Pfades angezeigt.

Applikation

Wählen Sie die gewünschte Applikation aus.

Datengruppe

Wählen Sie die gewünschte Datengruppe aus.

Klicken Sie auf "Weiter".

Sie gelangen auf die Seite "Pfad-Parameter".

Auf dieser Seite können Sie Pfadparameter für den Endpunkt definieren.

Allgemeine Erläuterungen zum Definieren von Pfad-Parametern finden Sie in Abschnitt Pfad-Parameter definieren.

Klicken Sie auf .

Klicken Sie auf "Datenfeld", wenn Sie die Pfad-Parameter einem Datenfeld zuordnen möchten.

Klicken Sie auf "Statisch", wenn Sie statische Pfad-Parameter anlegen möchten.

Im Folgenden wird davon ausgegangen, dass Sie einen statischen Parameter und den Primary Key als Pfad-Parameter mit Datenfeldzuordnung anlegen.

Klicken Sie auf "Statisch".

Die Eingabefelder für den Parameter sind aktiv.

Name

Erfassen Sie hier einen Namen für den Parameter.

Der Name darf in einem Endpunkt nur einmal vorkommen.

Der Name muss dem regulären Ausdruck [a-zA-Z][a-zA-Z\\d-_.]+ entsprechen. D.h. er muss mindestens zwei Zeichen lang sein und mit einem Buchstaben beginnen. Es sind nur Buchstaben, Zahlen, Minus, Unterstriche und Punkte erlaubt.

Zuordnung

Nehmen Sie keine Zuordnung vor, da es sich um einen statischen Parameter handelt.

Beschreibung

Erfassen Sie hier eine Beschreibung für den Parameter. Mehrzeilige Texte sind möglich. Die Beschreibung ist Bestandteil der Swagger Dokumentation.

Klicken Sie auf .

Klicken Sie auf "Datenfeld (PK) u (S) ID <string>".

Im linken Bereich der Seite wird der Parameter grün hinterlegt angezeigt.

Im rechten Bereich können Sie Angaben ändern bzw. ergänzen.

Name

Sie können den Namen des Parameters ändern.

Der Name muss mindestens zwei Zeichen lang sein und mit einem Kleinbuchstaben beginnen. Zudem darf er nur alphanumerische Zeichen und Unterstriche enthalten.

Zuordnung

Die Zuordnung ist inaktiv, da nur das Datenfeld "(PK)(S) ID <string>" als mögliche Auswahl zur Verfügung steht.

Beschreibung

Erfassen Sie hier eine Beschreibung für den Parameter. Mehrzeilige Texte sind möglich. Die Beschreibung ist Bestandteil der Swagger Dokumentation.

Sie gelangen auf die Seite "Query-Parameter".

Im Folgenden wird davon ausgegangen, dass für den hier beschriebenen Endpunkt kein Query-Parameter verwendet wird.

Klicken Sie auf "Fertigstellen".

Der erzeugte Endpunkt wird im Bereich "API-Endpunkte" angezeigt.