Einführung

Mit der REST-Call-Aktion haben Sie die Möglichkeit, während der Ausführung eines Prozesses HTTP-Calls an eine REST-API abzusetzen.

Die Response bzw. das Ergebnis des REST-Calls wird für die weitere Verarbeitung im Verarbeitungskontext (SharedState) vorgehalten.

In einen Prozess können Sie beliebig viele REST-Call-Aktionen einbinden. Dabei haben Sie die Möglichkeit, auf die in der Response zurückgegebenen Werte zuzugreifen. Damit können Sie beispielsweise in einem ersten REST-Call die Authentifizierungsdaten abfragen, um dann im darauffolgenden REST-Call die nächste Abfrage absetzen zu können.

Neben der Möglichkeit, über REST-Call-Aktionon auf den Verarbeitungskontext zuzugreifen, stehen Ihnen auch die gängigen Groovy-Methoden hierfür zur Verfügung. Weitere Informationen hierzu finden Sie unter folgendem Link Class SharedState.

Dialoggestütztes Erfassen der Daten - REST-API-Client

In der REST-Call-Aktion können Sie alle Angaben, die für den REST-Call erforderlich sind, dialoggestützt erfassen. Dabei werden Sie durch eine Reihe von Dialogen geführt, in denen die erforderlichen Angaben erfragt werden.

(Im Hintergrund fungiert der Apache HTTP Client 5 als REST-API-Client.)

Dynamische REST-Call-Aktionen - Resource-Mapping

Innerhalb jeder REST-Call-Aktion steht Ihnen das "Resource-Mapping" zur Verfügung. Mit dessen Hilfe können Sie REST-Call-Aktionen nahezu beliebig dynamisieren bzw. variabel gestalten. Dies können Sie tun, indem Sie in die REST-Call-Aktion Platzhalter einfügen, die sich aus verschiedenen Quellen speisen können. Wenn der REST-Call ausgeführt wird, werden die Platzhalter mit den zum Ausführungszeitpunkt ermittelten Werten belegt. Aus folgenden Quellen können Werte zum Ausführungszeitpunkt des REST-Calls bezogen werden:

Detaillierte Informationen hierzu finden Sie in Abschnitt Resource-Mapping.

Authentifizierungs-Möglichkeiten

In REST-Call-Aktion stehen folgende Authentifizierungs-Möglichkeiten zur Verfügung:

  • Basic-Authentifizierung

  • Authentifizierung per API-Key

  • Authentifizierung per Bearer-Token

Zudem können Sie eigene Authentifizierungen konstruieren.

Falls eine API Session-Cookies vergibt, können diese vorgehalten und in späteren REST-Call-Aktionen desselben Prozesses wiederverwendet werden.

Im folgenden Abschnitt finden Sie eine Übersicht die Tätigkeiten, die Sie beim Erfassen einer REST-Call-Aktion durchführen müssen:

REST-CALL-Aktion ausführen - Zentrale Schritte