Wiki-Quellcode von HTTP-Request

Zeige letzte Bearbeiter
1 {{figure image="post_request_de.png" clear="h1"}}
2 Oberfläche zur Einstellung der Parameter von Aktionen des Typs //HTTP-Request//.
3 {{/figure}}
4
5 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.
6
7 == Parameter ==
8
9 === Details für die HTTP-Anfrage ===
10
11 ; HTTP-Methode
12 : 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.
13 ; Sende URL
14 : Stellt die Adresse dar, an welche die //HTTP-Anfrage// geschickt werden soll.
15 ; Kein HTTP-Body
16 : Wenn eine eigene HTTP-Methode eingegeben wurde, kann hier festgelegt werden, ob diese Methode einen HTTP-Body unterstützt. In dem Fall werden dann Parameter als URL-Parameter angehängt und keine Dateien mitgesendet.
17 ; XSL-Template
18 : 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.
19 ; Zeichensatz des Aufrufs
20 : Legt fest, mit welchem Zeichensatz die //HTTP-Anfrage// gesendet wird.
21 ; Zeichensatz der Antwortseite
22 : Legt fest, mit welchem Zeichensatz die Antwort entgegengenommen werden soll.
23 ; Als Abschlussseite bereitstellen
24 : Liefert die Antwort der Aktion an den Client aus. Bei deaktivierter Option wird die Standardantwort von FORMCYCLE ausgeliefert.
25
26 {{figure image="post_request_extended_de.png" clear="h1"}}
27 Erweiterte Oberfläche zur Einstellung der Parameter von Aktionen des Typs //HTTP-Request//.
28 {{/figure}}
29
30 === Zusätzliche Parameter ===
31
32 ; Zusätzliche Header
33 : Hier kann eine Liste von Header hinterlegt werden, die in jedem Fall übertragen werden.
34 ; Alle Formularwerte übertragen
35 : Ist die Möglichkeit alle aus dem Formular erfassten Daten weiterzuleiten. Der Name des Formularelementes bzw. der [[Alias>>Formcycle.Designer.Form.ElementProperties.BaseProperties]] ist hierbei der Feldbezeichner innerhalb der //HTTP-Anfrage//. Der Wert ist die Eingabe aus dem Formular.
36 [[image:POST_Bezeichner.PNG]]
37 ; Aliasnamen verwenden (für Formularelemente und Uploads)
38 : Formularfelder werden mit ihren Formularfeldaliasen anstatt mit den Formularfeldnamen übertragen.
39 ; Zusätzliche Parameter
40 : 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.
41
42 === Dateien zum Request hinzufügen (Multipart-Request) ===
43
44 ; Dateien
45 : 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.
46
47 === Erweiterte Verbindungseinstellungen ===
48
49 ; Keine Fehler bei 4xx-Antworten
50 : 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.
51 ; Keine Fehler bei 5xx-Antworten
52 : 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.
53
54 **HTTP Basic-Authentifizierung**
55 ; Verwendung der HTTP Basic-Authentifizierung
56 : //Name//: Benutzername für die URL
57 : //Passwort//: Passwort für den Benutzer
58
59 **Proxy-Server benutzen**
60 ; Weiterleitung an einen Proxy-Server
61 : //Proxy-Server Hostname//: Name des Proxy-Servers
62 : //Port//: Port des Proxy-Servers. Standard ist {{code language="none"}}80{{/code}}.
63 ; Proxy Authentifizierung: Authentifizierung am Proxy-Server
64 : //Login//: Benutzername für den Proxy-Server
65 : //Passwort//: Passwort für den Proxy-Benutzer
66
67 === Ablage der erzeugten Dateien ===
68
69 ; An den Vorgang anhängen
70 : 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.
71
72 == Aktionsplatzhalter ==
73
74 Aktionen vom Typ //HTTP-Request// stellen [[Aktionsplatzhalter>>Formcycle.UserInterface.Variables||anchor="HAktionsplatzhalter"]] bereit, welche in darauf folgenden Aktionen verwendet werden können.
75
76 === Standardplatzhalter ===
77
78 ; [%$<Aktionsname>.SUCCESS%]
79 : Rückgabe ob Aktion erfolgreich ausgeführt wurde. Liefert Boolean (true/false) zurück.
80 ; [%$<Aktionsname>.RESULT%]
81 : Rückgabe aller von der Aktion bereitgestellten Ergebnisse in strukturierter Form.
82
83 ; [%$<Aktionsname>.ERROR_CODE%]
84 : Der geworfene Fehler-Code im Fehlerfall der Aktion. Leer, wenn kein Fehler aufgetreten ist.
85 ; [%$<Aktionsname>.ERROR_MESSAGE%]
86 : Die geworfene Fehler-Nachricht im Fehlerfall der Aktion. Leer, wenn kein Fehler aufgetreten ist.
87
88 === Aktionsspezifische Platzhalter ===
89
90 ; [%$<Aktionsname>.RESULT.redirectUrl%]
91 : Enthält im Fall einer Weiterleitung die URL zum Ziel
92 ; [%$<Aktionsname>.RESULT.redirected%]
93 : Liefert true zurück, wenn die HTTP-Anwort in einer Weiterleitung resultiert, sonst false.
94 ; [%$<Aktionsname>.RESULT.responseBody%]
95 : Enthält die Antwort, welche durch die ausgelösten HTTP-Anfrage zurückgeliefert wurde. Im Fall einer Weiterleitung ist dieser Wert leer.
96 ; [%$<Aktionsname>.RESULT.responseCode%]
97 : Enthält den zurückgelieferten HTTP-Statuscode
98 ; [%$<Aktionsname>.RESULT.responseJson%]
99 : 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
100 ; [%$<Aktionsname>.RESULT.responseReasonPhrase%]
101 : Enthält im Falle einer erfolgreichen HTTP-Anfrage die Statusnachricht, wie etwa "OK" oder "Found"
102 ; [%$<Aktionsname>.RESULT.responseStatusLine%]
103 : Enthält im Falle einer erfolgreichen HTTP-Anfrage die Statusnachricht, wie etwa "OK" oder "Found"
104 ; [%$<Aktionsname>.ERROR.redirectUrl%]
105 : Falls der Fehler-Code //SERVER_ERROR// oder //CLIENT_ERROR// ist: Enthält im Fall einer Weiterleitung die URL zum Ziel
106 ; [%$<Aktionsname>.ERROR.redirected%]
107 : Falls der Fehler-Code //SERVER_ERROR// oder //CLIENT_ERROR// ist: Liefert true zurück, wenn die HTTP-Anwort in einer Weiterleitung resultiert, sonst false.
108 ; [%$<Aktionsname>.ERROR.responseBody%]
109 : 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.
110 ; [%$<Aktionsname>.ERROR.responseCode%]
111 : Falls der Fehler-Code //SERVER_ERROR// oder //CLIENT_ERROR// ist: Enthält den zurückgelieferten HTTP-Statuscode
112 ; [%$<Aktionsname>.ERROR.responseJson%]
113 : 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
114 ; [%$<Aktionsname>.ERROR.responseReasonPhrase%]
115 : 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"
116 ; [%$<Aktionsname>.ERROR.responseStatusLine%]
117 : 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"
118 ; [%$<Aktionsname>.ERROR.message%]
119 : 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.