REST-Client-Transferobjekt
Mit dem REST-Client-Transferobjekt führen Sie innerhalb einer Verbindung einen konkreten REST-Aufruf aus.
Die Zuordnung zwischen REST-Client-Plug-in und Transferobjekt ist im Kapitel REST im OPC Router: Struktur und Zuständigkeiten beschrieben.
Der Konfigurationsdialog gliedert sich in die Reiter Allgemein, Anfrage und Antwort.
Allgemein
Auf dem Reiter „Allgemein“ wählen Sie die Anbindung und legen Endpunkt, HTTP-Methode sowie URL-Parameter fest.
Achten Sie bei der Eingabe des Endpunkts auf Groß- und Kleinschreibung. URLs und Pfade können sensitiv gegenüber Groß- und Kleinschreibung sein.
| Eigenschaft | Beschreibung |
|---|---|
| Anbindung | Hier stehen alle im Bereich Plug-ins erstellten REST-Client-Anbindungen zur Auswahl. Sollte die gewünschte Anbindung nicht dabei sein, können Sie diese im Plug-ins-Bereich als REST-Client bereitstellen. |
| Dynamischen Host verwenden | Wenn aktiv, kann der Host innerhalb der Verbindung als Parameter übergeben werden. Das ist sinnvoll, wenn derselbe Aufruf gegen unterschiedliche Zielsysteme ausgeführt werden soll. |
| Fail-Fast für Parameterfehler verwenden | Wenn aktiv, bricht das Transferobjekt bereits beim ersten fehlerhaften Parameter ab, statt den Aufruf fortzusetzen. |
| Transferfehler bei HTTP-Fehlercode erzeugen | Wenn aktiv, wird ein Transferfehler ausgelöst, sobald die Antwort einen HTTP-Fehlercode (zum Beispiel 4xx oder 5xx) zurückgibt. |
| Host | Zeigt die Host-Adresse der ausgewählten Anbindung an. Wenn Dynamischen Host verwenden aktiviert ist, kann der Host zur Laufzeit übergeben werden. |
| URL-Endpunkt | Endpunkt, der relativ zur konfigurierten Host-URL aufgerufen wird. Ist in der Anbindung eine OpenAPI-Datei hinterlegt, lässt sich der Endpunkt über die Schaltfläche „…“ aus einer Liste übernehmen. |
| Methode | HTTP-Methode des Aufrufs, zum Beispiel GET, POST, PUT oder DELETE. |
| Schrägstriche in URL-Segment-Parametern nicht kodieren | Wenn aktiv, werden Schrägstriche (/) in URL-Segment-Parametern nicht URL-kodiert, sondern unverändert übernommen. |
| URL-Segmente | Werte für Platzhalter im URL-Endpunkt (Typ URL-Segment). Über + legen Sie weitere Einträge an. |
| Query-Strings | Query-Parameter, die als ?Name=Wert an die URL angehängt werden. Über + legen Sie weitere Einträge an. |
| Test | Öffnet einen Testdialog, mit dem sich der REST-Aufruf prüfen lässt. Wenn der Aufruf erfolgreich ist, wird die Antwort angezeigt und den Antwortparametern können Werte zugeordnet werden. |
Endpunkte mit Platzhaltern
Wenn in der Anbindung eine OpenAPI-Datei hinterlegt ist, kann der Endpunkt aus einer Liste übernommen werden.
Enthält der Endpunkt Platzhalter in geschweiften Klammern, zum Beispiel /v2/{Benutzer}/details, legt der OPC Router dafür automatisch passende Anfrageparameter vom Typ URL-Segment an.
Request
Auf dem Reiter Request legen Sie den Inhalt der Anfrage sowie zusätzliche Header und Cookies fest.
| Eigenschaft | Beschreibung |
|---|---|
| Body-Typ | Format des Anfrageinhalts: none (kein Inhalt), raw, multipart/form-data, application/x-www-form-urlencoded oder application/octet-stream. Bei raw wählen Sie zusätzlich den Inhaltstyp: text/plain, text/html, application/xml oder application/json. Je nach Auswahl stellt der Dialog ein passendes Eingabefeld für den Anfrageinhalt bereit. |
| Header | HTTP-Header, die mit der Anfrage gesendet werden, zum Beispiel Authorization. Über + legen Sie weitere Header an. |
| Cookies | Cookies, die mit der Anfrage gesendet werden. Über + legen Sie weitere Cookies an. |
Response
Auf dem Reiter Response legen Sie fest, wie der Antwortinhalt verarbeitet wird und welche Werte aus der Antwort gelesen werden.
| Eigenschaft | Beschreibung |
|---|---|
| Body Text / Body Binär | Legt fest, ob der Antwortinhalt als Text oder als Binärdaten verarbeitet wird. |
| Antwort-Header als Arrays ausgeben | Wenn aktiv, werden die Antwort-Header als Arrays ausgegeben. Das ist sinnvoll, wenn ein Header mehrfach vorkommen kann. |
| Parameter | Parameter, die aus der Antwort gelesen und für die weitere Verarbeitung in der Verbindung bereitgestellt werden. Über + legen Sie weitere Parameter an. |
Verwendung in Verbindungen
- Wählen Sie auf dem Reiter „Allgemein“ die REST-Client-Anbindung aus.
- Legen Sie Endpunkt und HTTP-Methode fest und ergänzen Sie bei Bedarf URL-Segmente und Query-Strings.
- Konfigurieren Sie auf dem Reiter „Anfrage“ Body-Typ, Header und Cookies.
- Definieren Sie auf dem Reiter „Antwort“ die benötigten Antwortparameter.
- Prüfen Sie den Aufruf bei Bedarf über
Test.