Allgemeine Eigenschaften festlegen

Schritt-für-Schritt

Um eine REST-Call-Aktion zu erstellen, gehen Sie wie folgt vor:

  1. Starten Sie das Modul "Prozesse".

  2. Öffnen Sie einen bestehenden Prozess oder legen Sie einen neuen Prozess an.

  3. Ziehen Sie per Drag-and-drop die Aktion "REST-Call-Aktion" auf die Arbeitsfläche.

  4. Führen Sie einen Doppelklick auf die REST-Call-Aktion aus.

In den folgenden Abschnitten werden die einzelnen Dialogschritte beschrieben.

Im ersten Schritt müssen Sie allgemeine Eigenschaften der REST-Call-Aktion festlegen.

Alias

Erfassen Sie hier einen Alias für die REST-Call-Aktion.

Der Alias dient als Identifikation für die REST-Call-Aktion. Wenn Sie mehrere REST-Call-Aktionen innerhalb eines Prozesses verwenden, müssen sich die Aliase unterscheiden.

Der Alias muss mit einem Kleinbuchstaben beginnen und darf nur aus alphanumerischen Zeichen (Groß- und Kleinschreibung), sowie Unterstrichen (_) und Bindestrichen (-) bestehen.

Auf die Response einer REST-Call-Aktion kann während eines Prozesses über die Angabe des Alias zugegriffen werden.

Titel

Erfassen Sie hier einen sprechenden Titel für die REST-Call-Aktion.

Der Titel wird im Aktions-Element im Prozess-Designer angezeigt.

Beschreibung

Die Beschreibung kann zur Überlieferung von wichtigen Informationen bezüglich des REST-Calls verwendet werden.

Request und Response loggen

Wenn Sie diese Option aktivieren, wird der Request unmittelbar vor dem Versenden und die Response direkt nach dem Empfang geloggt. Die Option dient hauptsächlich dem Debuggen des Requests und sollte nur in Entwicklungsumgebungen eingesetzt werden. Denn zum einen kann die Logdatei extrem umfangreich werden und zum anderen können je nach API die geloggten Dateien auch Passwörter enthalten.

Binäre Response-Daten und sehr lange Responses (> 100.000 Zeichen) werden nicht ausgegeben. Einen entsprechenden Hinweis finden Sie in der Logdatei (Property: logVerbose).

JSON parsen

Wenn Sie diese Option aktivieren, wird der Payload der Response generell als JSON geparst.

Wenn der Payload erfolgreich als JSON geparst werden kann, wird das geparste JSON-Objekt an den REST-Call angehängt und steht ab dann im Shared State zur Verfügung.

Wenn der Payload nicht erfolgreich als JSON geparst werden kann, wird eine Meldung in die Logdatei geschrieben (Property: parseJson). In diesem Fall steht dann kein JSON-Objekt zur Verfügung.

Hostnamen verifizieren

Wenn Sie diese Option aktivieren, prüft der REST-API-Client, ob eine Verbindung mit dem korrekten Host hergestellt werden kann. Wenn der Host nicht verifiziert werden kann, wird die Verbindung abgelehnt und der Call scheitert (Property: hostnameVerification).

Allen Zertifikaten vertrauen

Wenn Sie diese Option aktivieren, wird eine https-Verbindung aufgebaut. Es findet aber keine Prüfung des Zertifikates statt.

Das Aktivieren dieser Option bietet sich für Entwicklungsumgebungen an, so dass Sie mit selbstsignierten Zertifikaten arbeiten können. Generell kann es sich in einer Entwicklungsumgebung anbieten, dass der REST-API-Client allen Zertifikaten vertraut (Property: trustAllCertificates).

Für den Produktivbetrieb können die Zertifikate in den Zertifikatsspeicher des Portals gelegt werden können.

Timeout (in Sekunden)

Hier können Sie die Zeit in Sekunden angeben, die der REST-API-Client auf den Aufbau einer Response wartet, beziehungsweise die Dauer, bis der REST-API-Client die Verbindung abbricht, wenn eine Response ausbleibt oder abreißt. Der Standard-Wert ist mit 30 Sekunden vorbelegt (Property: timeout).

Ihr nächster Schritt

Authentifizierung und Header konfigurieren