seit Version 3.27 | |
|---|
| 
|
FunktionDieses Objekt wird verwendet, um einen REST-Anruf an einen Webdienst durchzuführen. | Info |
|---|
| title | Programmiererfahrung erforderlich |
|---|
| Hinweis: Für die Verwendung dieses Objekts benötigen Sie Programmiererfahrung. jtel bietet im Rahmen des Standard-Supportvertrags keinen Entwickler-Support. |
Das Objekt kann folgende Arten von REST-Anrufen durchführen: Es ist möglich, Parameter anzugeben, die in der URL kodiert sind. Es ist auch möglich, zusätzliche Header anzugeben, die mit den http-Headern gesendet werden, wenn der REST-Anruf erfolgt. Wenn POST- oder PUT-Operationen durchgeführt werden, können Daten angegeben werden, die im Inhalt der http-Anforderung gesendet werden. Wenn der Aufruf zurückkehrt, werden die Header aus der Antwort als Variablen bereitgestellt, die dann in einem späteren Schritt in der Anwendung verwendet werden können. Der Body vom http Response wird geparsed, wenn gültiger XML oder JSON enthalten ist, und wird ebenfalls als Variablen bereitgestellt. Es ist möglich, ein Präfix für das Ergebnis (das die Kopfzeilen enthält) und ein separates Präfix für die bereitgestellten Inhaltsvariablen anzugeben. Parameter | Parameter | Zweck | Objekt Name | Der Name dieser Objektinstanz | Anfragemethode | Wählen Sie die zu verwendende http-Anforderungsmethode. GET, POST, PUT und DELETE werden unterstützt. | | Header | Eine beliebige Anzahl von Headern kann angegeben werden und wird mit der http-Anfrage mitgeschickt. Header müssen durch \n getrennt angegeben werden, wenn mehr als ein Header verwendet werden soll. Zum Beispiel: my-header-1: value1\n
my-header-2: value2 | | Parameter | Parameter werden am Ende der URL in dieser Form übergeben: http(s)://url?param1=value1¶m2=value2 Die Parameter werden je nach Bedarf automatisch URL-kodiert. | | Daten | Daten sind nur für POST- oder PUT-Operationen erforderlich. Die Daten werden, wie durch den "Content-Type" Parameter definiert, übergeben. | | Content-Type | Dieser Parameter wird als http-Header "Content-Type" übergeben und definiert, wie die in der POST- oder PUT-Anforderung enthaltenen Daten kodiert werden. Derzeit unterstützt werden: application/json
application/x-www-form-urlencoded
text/plain
text/xml | | Variablenpräfix Inhalt | Wenn der Webdienst Inhalte mit der http-Antwort zurückgibt, dann werden diese wie folgt bereitgestellt: Wenn gültiges XML, dann als Variablen in der Form: $<VariablePrefixContent>.xmlStructure.xmlFieldName
Wenn gültig JSON, dann als Variablen in der Form $<VariablePrefixContent>.jsonStructure.jsonFieldName
Das genaue Format hängt von der genauen zurückgegebenen Struktur ab. Sie sollten das Variablen-Dump-Objekt verwenden, um die Variablen zu untersuchen, die geparsed wurden.
Beispiel: | Item | Value |
|---|
| Variablenpräfix Inhalt | myContent | | Zurückgegebener Inhalt | { "token": "QpwL5tke4Pnpja7X" } | | Deklarierte Variablen | $myContent.responseData = { "token": "QpwL5tke4Pnpja7X" }
$myContent.token = QpwL5tke4Pnpja7X |
| | Variablenpräfix Ergebnis | Die Kopfzeilen sowie die http-Statuszeile und der Statuscode werden in Variablen gespeichert, denen der hier angegebene Wert vorangestellt wird. Die folgenden Variablen werden automatisch bereitgestellt (unter der Annahme einer gültigen http-Antwort): Beispiel: | Item | Value |
|---|
| Variablenpräfix Ergebnis | myResult | | http Status Zeile | HTTP/2 200 OK | | Header | content-type: application/json; charset=utf-8 set-cookie: __cfduid=d071fc20b4ada453375f3189252f1559d1556981085; expires=Sun, 03-May-20 14:44:45 GMT; path=/; domain=.test.com; HttpOnly | | Deklarierte Variablen | $myResult.httpResponseCode = 200
$myResult.httpResponse = HTTP/2 200 OK
$myResult.content-type = application/json; charset=utf-8
$myResult.set-cookie = __cfduid=d071fc20b4ada453375f3189252f1559d1556981085; expires=Sun, 03-May-20 14:44:45 GMT; path=/; domain=.test.com; HttpOnly |
|
Ausgänge Ausgang | Genutzt wenn ... | 200 OK | Eine 200 OK-Antwort wurde vom http-Server empfangen. | | Sonstiges | Sonstige andere Antworten wurden vom http-Server empfangen. | | Fehler | Es ist ein Fehler aufgetreten. Keine Antwort oder eine falsche Antwort wurde vom http-Server empfangen. |
Deklarierte Variablen"resultPrefix" wird durch das in der Objektdefinition angegebene Präfix ersetzt. Variable | Contains | resultPrefix.httpResponseCode | Der http-Antwort-Code. | | resultPrefix.httpResponse | Die http-Antwort. | | resultPrefix.responseData | Der http-Inhalt. | | resultPrefix.command | Der CURL-Befehl, als Referenz / zur Fehlersuche. | | resultPrefix.* | Andere http-Header, die vom Webdienst zur Verfügung gestellt werden. | | contentPrefix.* | Gepartete Variablen aus einer gültigen JSON- oder XML-Antwort. |
Release| Status |
|---|
| colour | Green |
|---|
| title | 3.14 ab 04.05.2019 |
|---|
|
| 
