Version: 5.2

REST-Client-Transferobjekt

Mit dem REST-Client Transferobjekt können REST-APIs in Verbindungen genutzt werden. Wie das Erstellen eines Transferobjektes funktioniert, wird auf der Seite Projektieren beschrieben.

Folgende Eigenschaften können für das REST-Client Transferobjekt konfiguriert werden:

warnung

Achtung: Bitte achten Sie bei der Eingabe der URL auf Klein- und Großschreibung. Die URLs sind Case sensitive!

Anbindung	REST-Client, der für dieses Transferobjekt genutzt werden soll.
Dynamischen Host verwenden	Wenn diese Option aktiv ist, kann der Host in der Verbindung als Parameter übergeben werden. Dies ist hilfreich, wenn Anfragen an verschiedene Hosts gesendet werden sollen. Bei der Testfunktion, die über den „Test“ aufgerufen wird, kann, wenn die Option aktiv ist eine Hostadresse eingegeben werden.
Host	Hier wird die Adresse angezeigt, die in der ausgewählten Anbindung festgelegt wurde.
URL-Endpoint	Adresse für den Endpunkt. Wenn für die gewählte Anbindung eine OpenAPI-Datei angegeben wurde, kann der Endpoint in einem Dropdown ausgewählt werden (siehe Grafik). Innerhalb der URL könne in geschweiften Klammern Platzhalter definiert werden. Z.B.: `/v2/{Platzhalter1}/user`. Diese Platzhalter werden automatisch als Parameter des Typ Url-Segment im Bereich der Request Parameter hinzugefügt und können anschließend wie gewohnt über die OPC Router Oberfläche beschrieben werden.
Methode	Methode, die für den Aufruf verwendet werden soll.
Format	Format, das für die Anfrage verwendet werden soll. z. B. JSON oder XML.
Request-Parameter	Die Parameter, die mit der Anfrage gesendet werden.
Response-Parameter	Hier können die erwarteten Rückgabeparameter einer Antwort angegeben werden. Diese sollten den Response-Parametern des angesprochenen Endpunktes entsprechen.
Test	Der „Test“-Button öffnet ein Modal, in dem überprüft werden kann, ob die Verbindung korrekt funktioniert. Mit dem „Senden“ Button kann der Aufruf ausprobiert werden. Wenn der Aufruf funktioniert, wird die erwartete Antwort (Response Body) angezeigt und den Response-Parametern werden entsprechende Werte zugewiesen.