HTTP-Request

Oberfläche zur Einstellung der Parameter von Aktionen des Typs HTTP-Request.

Aktionen des Typs HTTP-Request ermöglichen es, beliebige Anfragen per HTTP an Adressen stellen zu können. Dabei können auch Formulardaten und Dateien mitgesendet werden. Diese Aktion stellt damit eine Universalschnittstelle zu anderen Diensten dar.

Parameter

Details für die HTTP-Anfrage

HTTP-Methode: Die Methode, welche verwendet werden soll. Standardmäßig ist POST ausgewählt. Neben den verfügbaren Standard-Methoden wie GET oder DELETE kann auch eine eigene Methode eingegeben werden, wenn eine Schnitstelle dies erfordert. Einige Methoden wie GET oder DELETE unterstützen keinen Inhalt im HTTP-Body. Bei diesen Methoden werden Parameter als URL-Parameter and die URL gehängt, Dateien können nicht mitversendet werden.
Sende URL: Stellt die Adresse dar, an welche die HTTP-Anfrage geschickt werden soll.
XSL-Template: In den meisten Fällen wird der externe Dienst, an welchen die HTTP-Anfrage übertragen wurde, eine Antwort in Form von XML oder HTML zurückliefern. In einigen Fällen kann es notwendig sein, dass diese zur Anzeige gebracht oder in anderen Aktionen weiterverarbeitet werden sollen. Über die Auswahl eines XSL-Templates haben Sie die Möglichkeit, die zurücklieferte Antwort aufzubereiten oder anders zu formatieren.
Zeichensatz des Aufrufs: Legt fest, mit welchem Zeichensatz die HTTP-Anfrage gesendet wird.
Zeichensatz der Antwortseite: Legt fest, mit welchem Zeichensatz die Antwort entgegengenommen werden soll.
Als Abschlussseite bereitstellen: Liefert die Antwort der Aktion an den Client aus. Bei deaktivierter Option wird die Standardantwort von FORMCYCLE ausgeliefert.

Erweiterte Oberfläche zur Einstellung der Parameter von Aktionen des Typs HTTP-Request.

Typ des Requests

Der Anfrage-Typ bestimmt den Inhalt (body) des gesendeten HTTP-Request. Es kann zwischen folgenden Optionen gewählt werden:

Benutzerdefiniert: Sendet den eingegeben Text als Inhalt des HTTP-Body.
Automatisch gemäß des Inhalts: Aus Gründen der Abwärtskompatibilität: Verwendet x-www-form-urlencoded, wenn keine Dateien existieren und x-www-form-urlencoded, wenn wenigstens eine Datei ausgewählt wurde und zum Zeitpunkt des Ausführens der Aktion exisiert.
Inhalt einer Datei: Sendet den binären Inhalt der ausgewählten Datei als Inhalt des HTTP-Body.
Formulardaten ohne Dateien (form-urlencoded): Sendet einen Request-Body mit einem URL-kodierten Plain-Text-String, welcher die Daten enthält (x-www-form-urlencoded). Dieser Typ unterstützt nicht das Senden von Dateien.
Formulardaten inklusive Dateien (multipart): Sendet einen Multipart-Body (multipart/form-data) mit den Daten. Dieser Typ unterstützt das Senden von Dateien.
URL mit Parametern: Sendet keinen Body, sondern hängt alle Daten als URL-Parameter an die Anfrage-URL an. Dieser Typ unterstützt nicht das Senden von Dateien.

Zusätzliche Parameter

Zusätzliche Header: Hier kann eine Liste von Header hinterlegt werden, die in jedem Fall übertragen werden.
Alle Formularwerte übertragen: Ist die Möglichkeit alle aus dem Formular erfassten Daten weiterzuleiten. Der Name des Formularelementes bzw. der Alias ist hierbei der Feldbezeichner innerhalb der HTTP-Anfrage. Der Wert ist die Eingabe aus dem Formular.
Aliasnamen verwenden (für Formularelemente und Uploads): Formularfelder werden mit ihren Formularfeldaliasen anstatt mit den Formularfeldnamen übertragen.
Zusätzliche Parameter: Hier kann eine Liste von Parametern hinterlegt werden, die in jedem Fall übertragen werden. Häufig werden hier zusätzliche statische Informationen hinterlegt, die von dem externen Dienst benötigt werden, oder wenn Feldbezeichner anders als im Formular hinterlegt erwartet werden.

Dateien zum Request hinzufügen (Multipart-Request)

Dateien: Auswahl von Dateien die zum Request hinzugefügt werden können. Dies ist nur möglich, wenn die HTTP-Methode auch einen HTTP-Body unterstützt. Siehe Aktionen für eine Liste der unterstützten URL-Protokolle.

Erweiterte Verbindungseinstellungen

Keine Fehler bei 4xx-Antworten: Standardmäßig wird der Fehler CLIENT_ERROR geworfen, wenn die Antwort einen 4xx-Statuscode enthält. Der Inhalt der HTTP-Antwort ist dann über ERROR-Platzhalter verfügbar. Ist die Option aktiviert, wird kein Fehler geworfen und der Inhalt der Antwort stehen über RESULT-Platzhalter bereit.
Keine Fehler bei 5xx-Antworten: Standardmäßig wird der Fehler SERVER_ERROR geworfen, wenn die Antwort einen 5xx-Statuscode enthält. Der Inhalt der HTTP-Antwort ist dann über ERROR-Platzhalter verfügbar. Ist die Option aktiviert, wird kein Fehler geworfen und der Inhalt der Antwort stehen über RESULT-Platzhalter bereit.

HTTP Basic-Authentifizierung

Verwendung der HTTP Basic-Authentifizierung: Name: Benutzername für die URL; Passwort: Passwort für den Benutzer

Proxy-Server benutzen

Weiterleitung an einen Proxy-Server: Proxy-Server Hostname: Name des Proxy-Servers; Port: Port des Proxy-Servers. Standard ist 80.
Proxy Authentifizierung: Authentifizierung am Proxy-Server: Login: Benutzername für den Proxy-Server; Passwort: Passwort für den Proxy-Benutzer

Ablage der erzeugten Dateien

An den Vorgang anhängen: Wenn diese Option angewählt wird, werden in dieser Aktion erzeugte Dateien an den Vorgang angehangen. Ansonsten stehen Sie nur innerhalb des Workflows für Aktionen innerhalb der selben Verarbeitungskette zur Verfügung.

Aktionsplatzhalter

Aktionen vom Typ HTTP-Request stellen Aktionsplatzhalter bereit, welche in darauf folgenden Aktionen verwendet werden können.

Standardplatzhalter

[%$<Aktionsname>.SUCCESS%]: Rückgabe ob Aktion erfolgreich ausgeführt wurde. Liefert Boolean (true/false) zurück.
[%$<Aktionsname>.RESULT%]: Rückgabe aller von der Aktion bereitgestellten Ergebnisse in strukturierter Form.

[%$<Aktionsname>.ERROR_CODE%]: Der geworfene Fehler-Code im Fehlerfall der Aktion. Leer, wenn kein Fehler aufgetreten ist.
[%$<Aktionsname>.ERROR_MESSAGE%]: Die geworfene Fehler-Nachricht im Fehlerfall der Aktion. Leer, wenn kein Fehler aufgetreten ist.

Aktionsspezifische Platzhalter

[%$<Aktionsname>.RESULT.redirectUrl%]: Enthält im Fall einer Weiterleitung die URL zum Ziel
[%$<Aktionsname>.RESULT.redirected%]: Liefert true zurück, wenn die HTTP-Anwort in einer Weiterleitung resultiert, sonst false.
[%$<Aktionsname>.RESULT.responseBody%]: Enthält die Antwort, welche durch die ausgelösten HTTP-Anfrage zurückgeliefert wurde. Im Fall einer Weiterleitung ist dieser Wert leer.
[%$<Aktionsname>.RESULT.responseCode%]: Enthält den zurückgelieferten HTTP-Statuscode
[%$<Aktionsname>.RESULT.responseJson%]: Enthält ein JSON-Objekt oder JSON-Array, wenn es sich bei der HTTP-Antwort nicht um eine Weiterleitung handelt und der content-type des zurückgegebenen Inhalt application/json ist
[%$<Aktionsname>.RESULT.responseReasonPhrase%]: Enthält im Falle einer erfolgreichen HTTP-Anfrage die Statusnachricht, wie etwa "OK" oder "Found"
[%$<Aktionsname>.RESULT.responseStatusLine%]: Enthält im Falle einer erfolgreichen HTTP-Anfrage die Statusnachricht, wie etwa "OK" oder "Found"
[%$<Aktionsname>.ERROR.redirectUrl%]: Falls der Fehler-Code SERVER_ERROR oder CLIENT_ERROR ist: Enthält im Fall einer Weiterleitung die URL zum Ziel
[%$<Aktionsname>.ERROR.redirected%]: Falls der Fehler-Code SERVER_ERROR oder CLIENT_ERROR ist: Liefert true zurück, wenn die HTTP-Anwort in einer Weiterleitung resultiert, sonst false.
[%$<Aktionsname>.ERROR.responseBody%]: Falls der Fehler-Code SERVER_ERROR oder CLIENT_ERROR ist: Enthält die Antwort, welche durch die ausgelösten HTTP-Anfrage zurückgeliefert wurde. Im Fall einer Weiterleitung ist dieser Wert leer.
[%$<Aktionsname>.ERROR.responseCode%]: Falls der Fehler-Code SERVER_ERROR oder CLIENT_ERROR ist: Enthält den zurückgelieferten HTTP-Statuscode
[%$<Aktionsname>.ERROR.responseJson%]: Falls der Fehler-Code SERVER_ERROR oder CLIENT_ERROR ist: Enthält ein JSON-Objekt oder JSON-Array, wenn es sich bei der HTTP-Antwort nicht um eine Weiterleitung handelt und der content-type des zurückgegebenen Inhalt application/json ist
[%$<Aktionsname>.ERROR.responseReasonPhrase%]: Falls der Fehler-Code SERVER_ERROR oder CLIENT_ERROR ist: Enthält im Falle einer erfolgreichen HTTP-Anfrage die Statusnachricht, wie etwa "OK" oder "Found"
[%$<Aktionsname>.ERROR.responseStatusLine%]: Falls der Fehler-Code SERVER_ERROR oder CLIENT_ERROR ist: Enthält im Falle einer erfolgreichen HTTP-Anfrage die Statusnachricht, wie etwa "OK" oder "Found"
[%$<Aktionsname>.ERROR.message%]: Fehlernachricht, der zurückgeliefert wird, wenn die angebene externe URL-Ressource keinem gültigen Format entspricht, der angebundene Server nicht erreicht werden kann oder keine Antwort zurückliefert, beim Hinzufügen von Dateien zur HTTP-Anfrage Fehler aufgetretten ist oder die konfiguriert XSLT-Transformation fehlgeschlagen ist.