Endpunkt - Prozess mit "POST" auslösen

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 "Prozess-Endpunkt".

3. Klicken Sie auf "Weiter".

   Sie gelangen auf den Dialog-Schritt "Prozess-Auswahl".

Endpunkt

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

Aktion

Wählen Sie "POST" aus.

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

Prozess

Wählen Sie hier den Prozess aus, den Sie auslösen möchten.

Ereignisbehandler

Wählen Sie hier den Ereignisbehandler aus, mit dem der Prozess gestartet werden soll.

Zur Auswahl stehen nur Generische Ereignisbehandler, bei denen die Klasse de.uplanet.lucy.server.workflow.eventhandler.UserWorkflowEventHandler ausgewählt wurde.

Klicken Sie auf "OK".

Klicken Sie auf "Weiter".

Sie gelangen in den Dialog-Schritt "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.

1. Klicken Sie auf .

   

2. Klicken Sie auf "Variabel", wenn Sie variable Pfad-Parameter anlegen möchten.

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

   In den folgenden Schritten wird davon ausgegangen, dass Sie einen statischen Pfad-Parameter anlegen.

3. 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.

   Variabler Parameter

   Wenn Sie dieses Kontrollkästchen aktivieren, wird der statische Pfad-Parameter zu einem variablen Pfad-Parameter.

   Datentyp

   Wählen Sie hier den Datentyp des Pfad-Parameters aus.

   Der Datentyp des eingehenden Pfad-Parameters muss mit dem hier gewählten Datentyp übereinstimmen. Wenn die Datentypen nicht übereinstimmen, wird der entsprechende Request nicht verarbeitet.

   Beschreibung

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

4. Klicken Sie auf "Weiter".

   Sie gelangen in den Dialog-Schritt "Query-Parameter".

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

1. Klicken Sie auf "Weiter".

   Sie gelangen in den Dialog-Schritt "Request JSON-Body".

1. Klicken Sie auf .

   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.

   Fallback

   Hier können Sie einen Fallback-Wert für den Parameter hinterlegen.

   Der Fallback-Wert kommt zum Tragen, wenn der Parameter auf jeden Fall ausgewertet werden soll und gleichzeitig ein Wert für den Parameter beim Aufrufen des Endpunkts nicht zwingend mitgegeben werden muss.

   Datentyp

   Wählen Sie hier den Datentyp des Pfad-Parameters aus.

   Der Datentyp des eingehenden Pfad-Parameters muss mit dem hier gewählten Datentyp übereinstimmen. Wenn die Datentypen nicht übereinstimmen, wird der entsprechende Request nicht verarbeitet.

   Parameter ist erforderlich

   Wenn Sie das Kontrollkästchen aktivieren, ist der Parameter für den Request zwingend anzugeben.

   Das Aktivieren des Kontrollkästchens kann u.a. dann hilfreich sein, wenn ein Parameter auf jeden Fall erwartet wird, ein sinnvoller Fallback aber nicht definiert werden kann (beispielsweise eine Benutzer-ID).

   Beschreibung

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

2. Erfassen Sie die Parameter.

   Es handelt sich um die Parameter, die der Prozess benötigt. Die Parameter werden im Verarbeitungskontext des Prozesses verarbeitet.

3. Klicken Sie auf "Weiter".

   Sie gelangen in den Dialog-Schritt "Response JSON-Body".

Hier können Sie die Parameter erfassen, die der Prozess zurückgeben soll.

Im Folgenden wird davon ausgegangen, dass für den hier beschriebenen Endpunkt keine Parameter für den Response JSON-Body verwendet werden.

Klicken Sie auf "Fertigstellen".

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