Auslösen von Ereignissen

Ziel/UseCase

Löst ein BPMN-Event aus, das zurzeit darauf wartet ausgelöst zu werden.

Zugriffsberechtigungen

Siehe auch Umgang mit Events.

TODO: Zusätzliche Infos zu der Schnittstelle aufschreiben.

Was passiert in der Process Engine

TODO: Das verhalten der Schnittstelle in der Process Engine beschreiben.

Parameter

Erforderliche Parameter

  • context - Der Kontext in dem die Abarbeitung der Funktion geschehen soll (enthält u.A. einen Token, der den Aufrufer der Funktion identifiziert).
  • process_model_key - Der Key der das Prozessmodell identifiziert, welches das auszulösende Event beinhaltet.
  • correlation_id - Die ID die den Vorgang identifiziert, zu dem das wartende Event gehört.
  • event_id - Die ID des Events das ausgelöst werden soll.

Optionale Parameter

  • payload - Ein Payload mit dem das Event ausgelöst werden soll

    TODO: Define the event trigger payload object

Ergebnis/Rückgabewerte

TODO: Die Rückgabewerte dieser Schnittstelle beschreiben.

Fehler, die erwartet werden müssen

Mögliche auftretende Fehler sind:

  • 400: Der bereitgestellte Payload ist ungültig
  • 401: Der anfragende Benutzer hat keine gültige Authentifizierung
  • 403: Der anfragende Benutzer ist nicht berechtigt diesen Request auszuführen
  • 404:
    • Es konnte kein Prozessmodell mit dem gegebenen process_model_key gefunden werden
    • Es konnte keine Correlation mit der gegebenen correlation_id gefunden werden
    • Es konnte kein Event mit der gegebenen Event4 gefunden werden
  • 500: Beim Verarbeiten der Anfrage trat ein systeminterner Fehler auf

REST/Messagebus API

Die HTTP-Route für die Schnittstelle sieht so aus:

POST /process_models/:process_model_key/correlations/:correlation_id/events/:event_id/trigger

// body
// TODO: define request body/the event trigger payload

IConsumerApi Schnittstelle

TODO: Schnittstelle definieren

results matching ""

    No results matching ""