Request konfigurieren

In diesem Schritt müssen Sie Angaben zur API-Ressource machen und die Query-Parameter über Key/Value-Paare erfassen.

Methode

Wählen Sie hier das HTTP-Verb bzw. die HTTP-Methode, die für den REST-Call verwendet werden soll.

Folgende Methoden können Sie auswählen:

  • GET

  • POST

  • PATCH

  • PUT

  • DELETE

Schema

Legen Sie hier fest, ob der REST-Call eine HTTP oder HTTPS-Verbindung nutzen soll.

HTTPS Wenn Sie HTTPS als Verbindung auswählen, müssen Sie Folgendes beachten:

Ein geeignetes Zertifikat muss im Intrexx-Zertifikatsspeicher hinterlegt sein.

ODER

Die Option "Hostname verifizieren" auf der Registerkarte "Allgemein" muss deaktiviert sein und die Option "Allen Zertifikaten vertrauen" auf der Registerkarte "Allgemein" muss aktiviert sein. Wenn dies nicht der Fall ist, dann wird der REST-Call abgebrochen.

HTTP Wenn Sie HTTP als Verbindung auswählen, wird in der Log-Datei eine Warnung ausgegeben, da Login-Credentials, Keys usw. dann im Klartext bzw. nur unzureichend obfuskiert sind.

Port (optional)

Erfassen Sie hier den Port der API auf dem Host-System.

Wenn Sie keinen Wert eingeben, werden folgende Default-Werte verwendet:

  • Port 443 (bei HTTPS)

  • Port 80 (bei HTTP)

Hostname

Erfassen Sie hier den Hostnamen der API. Erfassen Sie den Hostnamen ohne die Angabe von "http://" oder "https://" und ohne die Angabe von Pfad- und Query-Parametern.

Pfad

Erfassen Sie hier den Pfad zur gewünschten API-Ressource.

Download-Dateiname (optional)

Erfassen Sie hier einen Dateinamen, falls der REST-Call einen Datei-Download auslöst.

Die Datei wird nach dem Download unter dem hier hinterlegten Namen in einem temporären Verzeichnis abgelegt, das für die Dauer der Prozess-Ausführung besteht und danach wieder gelöscht wird. Das Verzeichnis ist über das Groovy-Objekt g_dirWorkflowTmp erreichbar. Im Verarbeitungskontextobjekt des REST-Calls steht unter <aliasDesCalls>.body.file der absolute Pfad als String zur Verfügung.

Wenn Sie keinen Dateinamen erfassen, durchsucht der REST-Call den Content-Disposition-Header der Response und prüft, ob dort gegebenenfalls ein Dateiname angegeben ist. Wenn kein Dateiname gefunden wird, dann wird der Name "download" als Default verwendet.

Query-Parameter

Schritt-für-Schritt

Um Query-Parameter hinzuzufügen, gehen Sie wie folgt vor:

  1. Öffnen Sie die REST-Call-Aktion.

  2. Wechseln Sie auf die Registerkarte "Request".

  3. Klicken Sie auf das - Icon.

    Das Dialogfenster "Query-Parameter hinzufügen" wird angezeigt.

  4. Erfassen Sie einen Key und einen Wert. Den Wert können Sie manuell eingeben oder aus dem Resource-Mapping beziehen oder eine Kombination aus beidem nutzen.

  5. Klicken Sie auf "OK".

    Der hinzugefügte Query-Parameter wird angezeigt.

Die Query-Parameter werden im generierten REST-Call hinter dem Pfad mit einem "?" getrennt angehängt, wobei Key und Value mit "=" verbunden und die Paare mit "&" getrennt werden.

Ihr nächster Schritt

Body konfigurieren