Zum Inhalt springen

Generic Rest Service Writer

Die Komponente Generic Rest Service Writer ermöglicht den Aufruf eines beliebigen REST-Endpunkts über HTTP oder HTTPS.

Sie stellt eine generische Integrationskomponente dar, mit der externe Webservices angesprochen werden können. Dabei können unterschiedliche Authentifizierungsverfahren, HTTP-Methoden sowie verschiedene Arten von Request-Daten (Body, Datei, Parameterliste) verwendet werden.

Die eigentliche fachliche Verarbeitung oder Transformation der übertragenen Daten erfolgt nicht innerhalb dieser Komponente, sondern in vorgelagerten Prozesskomponenten.

Bei erfolgreicher Verarbeitung eines Requests mit HTTP-Statuscode 200 wird die Antwort des REST-Endpunkts als Datenstream (ContentBuffer) im Prozesskontext gespeichert und kann anschließend weiterverarbeitet werden.

Authentifizierung

Feld Beschreibung
Authentifizierung Methode Definiert das Authentifizierungsverfahren für den REST-Aufruf. Unterstützte Werte: Keine, Basic, Bearer.
Authentifizierung API Key API-Key bzw. Bearer-Token für die Bearer-Authentifizierung. Der Token wird vom Betreiber des REST-Endpunkts bereitgestellt.
Authentifizierung Benutzer Benutzer für die Basic-Authentifizierung (Benutzername/Passwort). Der Benutzer muss im Datacenter unter Communication → Ressourcen konfiguriert sein.

REST-Service Konfiguration

Feld Beschreibung
REST Service Base URI Definiert das Protokoll, den Servernamen und den Port des REST-Endpunkts, z. B. https://FQDN:12345.
REST Service Request Route Definiert den relativen Pfad der aufzurufenden REST-Methode. Der Pfad kann statisch oder dynamisch sein. Platzhalter werden mit {} definiert und aus einer Datenquelle ersetzt. Beispiel statisch: /api/methode Beispiel dynamisch: /api/{DynamischerWert}/methode.
REST Service Request Route Datenquelle Definiert das DataItem, das die Werte für Platzhalter in der Request-Route bereitstellt.
REST Service Methode Definiert die HTTP-Methode des Aufrufs. Unterstützte Methoden: GET, POST, PUT, DELETE.
REST Service ContentType Definiert explizit den Content-Type des Requests (z. B. application/json, application/xml, application/octet-stream). Wird kein Wert gesetzt, wird der Content-Type aus der übergebenen Quelle ermittelt.
REST Service Header Erweiterungen Ermöglicht das Hinzufügen zusätzlicher HTTP-Header zum Request (z. B. Accept: application/gzip).
REST Service Timeout (ms) Definiert den Timeout in Millisekunden für den Verbindungsaufbau und die Ausführung des REST-Aufrufs.

Quellkonfiguration (Request Body / Parameter)

Feld Beschreibung
Quell-Typ Definiert die Art der zu übertragenden Daten. Mögliche Werte: Keine, Quell-DataItem, Quell-ContentBuffer, Quell-FileReference, Quell-Parameterliste.
Quelle Referenziert – abhängig vom gewählten Quell-Typ – das entsprechende Objekt im Prozesskontext (DataItem, ContentBuffer, FileReference).
Quell-Parameterliste Definiert Request-Parameter für GET- oder DELETE-Aufrufe. Die Parameter werden als Query-String an die URI angehängt, z. B. /api/methode?param1=wert1&param2=wert2.

Verhalten je Quell-Typ

  • Keine → Es wird kein Request-Body übertragen.
  • Quell-DataItem → Das DataItem wird serialisiert (z. B. als JSON oder XML) und in den Request-Body geschrieben.
  • Quell-ContentBuffer → Der enthaltene Datenstream wird unverändert in den Request-Body übertragen.
  • Quell-FileReference → Die referenzierte Datei wird direkt in den Request-Body übertragen.
  • Quell-Parameterliste → Die Parameter werden als Query-String an die Request-URI angehängt.

Antwortverarbeitung

Feld Beschreibung
Outputname Definiert den Namen des DataItems im Prozesskontext, in dem die Antwort des REST-Endpunkts gespeichert wird. Die Antwort wird als ContentBuffer abgelegt.

Nur Requests mit HTTP-Statuscode 200 werden als erfolgreich verarbeitet.
In diesem Fall wird der Response-Stream im konfigurierten Outputname-Objekt im Prozesskontext gespeichert und steht nachfolgenden Prozesskomponenten zur Weiterverarbeitung zur Verfügung.

Zuletzt aktualisiert am