Prozess-Endpunkt erstellen

Mit Prozess-Endpunkten können Sie Prozesse auslösen.

Als Startpunkt des Prozesses müssen Sie einen Generischen Ereignisbehandler mit der Java-Klasse de.uplanet.lucy.server.workflow.eventhandler.UserWorkflowEventHandler auswählen. Ansonsten kann der Prozess die üblichen Bedingungen und Aktionen enthalten.

Sie sollten zunächst den Prozess und anschließend den Prozess-Endpunkt erstellen, da beim Erstellen des Prozess-Endpunkts der entsprechende Prozess und Ereignisbehandler ausgewählt werden müssen.

Zudem können Sie dem Prozess mit dem Prozess-Endpunkt Parameter übergeben. Sie sollten daher die Parameter, die der Prozess erwartet bzw. entgegennehmen soll, beim Erstellen des Prozess-Endpunkts kennen.

Methoden

Beachten Sie, dass die Angabe der Methode bei Prozess-Endpunkten (nur) einen informativen Wert hat. Wenn Sie also beispielsweise POST verwenden, sollten Sie dies tun, wenn der ausgelöste Prozess einen Datensatz schreibt oder ganz allgemein etwas "erzeugt". Oder verwenden Sie GET, wenn der Prozess etwas zurückliefern soll.

Bei Prozess-Endpunkten bewirkt die Angabe der Methode keine Funktionalität. Sie dient den Benutzern bzw. Konsumenten der API (lediglich) zu einem guten Verständnis des API-Endpunkts.

Bei den Prozess-API-Endpunkten stehen folgende Methoden zur Verfügung:

  • GET

  • POST

  • PUT

  • PATCH

  • DELETE

Überblick über die folgenden Abschnitte

Im nächsten Abschnitt finden Sie zunächst eine Anleitung zum Erstellen eines Prozesses, der anschließend mit einem Prozess-Endpunkt ausgelöst werden kann.

Anschließend finden Sie eine Anleitung für das Anlegen eines Prozess-Endpunkts mit der Methode POST.