Endpunkt

Konfiguration des HTTP-Endpunkts (siehe auch HTTP-Endpunkt Einstellungen)

WmsSettingMapping

⚠

Relative URL

Relative URL, mit der die beim Endpunkt hinterlegte URL ergänzt werden kann

String

HTTP-Methode

Methode, mit dem der HTTP-Request abgesetzt werden soll.

Derzeit unterstützen wir folgende Methoden: GET, PATCH, POST, PUT, DELETE

Auswahl vom Typ String

Header bearbeiten…

Die Header können als Schlüssel/Werte-Paar in einem Dialog erfasst werden. Diese ergänzen die bereits beim Endpunkt angegebenen Header.

Ein bereits beim Endpunkt angegebener Header kann mit einem anderen Wert bei der Aktivität überschrieben werden. Hierzu wird der Schlüssel in der unteren Liste erneut hinzugefügt.

Die Schlüssel der Header sind eindeutig, als Wert kann auch eine Variable verwendet werden.

Beim Schlüssel und den Werten sollte die Groß-/Kleinschreibung beachtet werden, da diese bei manchen Web-APIs berücksichtigt wird.

In der oberen Liste werden die Headers aufgelistet, welche bereits beim Endpunkt konfiguriert wurden. Diese Liste lässt sich nicht bearbeiten.

In der untern Liste können weitere Header für die Aktivität konfiguriert werden. Die hier gelisteten Header können bearbeitet und auch gelöscht werden. Es muss immer ein Schlüssel angegeben werden. Einträge mit leerem Schlüssel werden nicht übernommen.

Die Schaltfläche wird farblich hervorgehoben, sobald ein oder mehrere Header angegeben wurden.

Auflistung von Schlüssel/Werte-Paaren

URL Parameter bearbeiten…

Analog zu den Headern können auch URL-Parameter als Schlüssel/Werte-Paar erfasst werden.

Alternativ können die URL-Parameter auch direkt in der relativen URL angegeben werden.

Die Schaltfläche wird farblich hervorgehoben, sobald ein oder mehrere URL-Parameter angegeben wurden.

Auflistung mit Schlüssel/Werte-Paaren

Content bearbeiten…

Wird für den HTTP-Request ein Content erwartet, kann dieser als Text oder FormUrlEncoded angegeben werden. Ob und wie ein Content angegeben werden muss, wird üblicherweise in der API-Beschreibung detailliert beschrieben.

Beim textbasierten Content stehen folgende Optionen zur Verfügung:

Content(Datentyp String):
Hier werden die Daten angegeben. Je nach Schnittstelle können diese als Text, XML oder Json gefordert werden.

Content-Typ (Datentyp String):
Wird ein Content als Text angegeben, muss auch der Content-Typ angegeben werden. Die gängisten Content-Typen können aus der Liste ausgewählt werden (z.B. text/plain, application/json, etc.), es können jedoch auch andere Content-Typen angegeben werden, welche nicht in der Liste enthalten sind.

Encoding (Datentyp Encoding):
Hier kann ein Encoding ausgewählt werden. Meist wird jedoch UTF-8 verwendet (siehe auch Encoding)

BOM hinzufügen (Datentyp Bool):
Einstellung, ob beim Schreiben einer UTF-8 Datei das Byte Order Mark am Anfang eingefügt werden soll (Standard: ja). Das Kennzeichen steht nur beim Encoding UTF-8 zur Verfügung.

Beim FormUrlEncoded Content können die Daten als Schlüssel/Werte-Paare erfasst werden. Es muss immer ein Schlüssel angegeben werden. Einträge mit leerem Schlüssel werden nicht übernommen.

Die Schaltfläche wird farblich hervorgehoben, sobald ein Content angegeben wurden.

Weitere Einstellungen bearbeiten…

Über diese Schaltfläche können weitere Einstellungen konfiguriert werden.

Verzeichnis (Datentyp String):
Soll über den HTTP-Request eine Datei abgerufen werden (z.B. ein PDF-Dokument), kann diese nicht als String zurückgegeben werden. Deshalb bieten wir die Möglichkeit, diese Datei auf dem Filesystem zu speichern. Für diesen Fall muss hier ein Verzeichnis angegeben werden.

Dateiname (Datentyp String):
Name, unter dem die Datei gespeichert werden soll. Wird kein Dateiname angegeben, wird versucht, den Original-Dateinamen aus der Response zu ermitteln. Ist dies nicht möglich, wird die Datei unter dem Namen "Content_{DateTime.Now:yyyyMMdd-HHmmss}.{fileExtension}" gespeichert, wobei die fileExtension aus dem MimeType ermittelt wird.

Bestehende Datei überschreiben:
Kennzeichen, ob eine bestehende Datei überschrieben werden soll. Wenn nicht, wird ein Fehler geworfen, wenn die Datei bereits existiert.

Zielverzeichnis erstellen:
Kennzeichen, ob das Zielverzeichnis erstellt werden soll, sofern dieses noch nicht vorhanden ist. Wenn nicht, wird ein Fehler geworfen, wenn das Verzeichnis noch nicht existiert.

Timeout in Sekunden:
Dauer des Requests in Sekunden, bis wann eine Rückmeldung vom Service erfolgen muss, bevor der Request mit einem Timeout abbricht. (Standard: 100, maximaler Wert: 3.600)

Max. Nachrichtengröße in MB:
Maximale Größe der Nachricht in Megabyte (Standard / maximaler Wert: 2.048)

Die Schaltfläche wird farblich hervorgehoben, sobald ein Verzeichnis zum Speichern der Datei angegeben wurden.

StatusCode

StatusCode des abgesetzten HTTP-Requests (z.B. 200 für einen erfolgreichen Aufruf)

Mit dem StatusCode kann geprüft werden, ob der HTTP-Request erfolgreich gesendet wurde oder ob ein Fehler aufgetreten ist.

Integer

Content

Der zurückgegebene Content.

Die Formatierung (z.B. Text, Json, XML, etc.) kann üblicherweise der Beschreibung der angesteuerten Schnittstelle entnommen werden.

String

Endpunkt ist nicht vorhanden oder nicht erreichbar

Datei existiert bereits

ActivityException

Der Mandant darf auf das angegeben Verzeichnis nicht zugreifen

ActivityException

Zielverzeichnis ist nicht vorhanden