Endpunkt

Zuordnung zu einem HTTP-Endpunkt (Diese können unter HTTP-Endpunkt Einstellungen konfiguriter werden)

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. Folgende Methoden stehen zur Auswahl: GET, PATCH, POST, PUT, DELETE

String

Header bearbeiten…

Die Header können als Name-Werte-Paar in einem Dialog erfasst werden. Diese ergänzen die bereits beim Endpunkt angegebenen Header. Es muss immer ein Name angegeben werden. Einträge ohne Namen werden nicht übernommen.

In der oberen Liste werden die Header aufgelistet, welche bereits beim Endpunkt konfiguriert wurden. Diese Liste lässt sich nicht bearbeiten. Ein bereits beim Endpunkt angegebener Header kann in der Aktivität überschrieben werden. Fügen Sie dazu einen Eintrag mit dem selben Namen in die untere Liste ein.

In der unteren Liste können weitere Header für die Aktivität konfiguriert werden. Diese können bearbeitet und gelöscht werden.

Die Namen der Header sind eindeutig, als Wert kann auch eine Variable verwendet werden. Beim Namen und den Werten sollte die Groß-/Kleinschreibung beachtet werden, da diese bei manchen Web-APIs berücksichtigt wird.

Open

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

URL Parameter bearbeiten…

Analog zu den Headern können auch URL-Parameter als Name-Werte-Paar erfasst werden. Alternativ können Sie die URL-Parameter auch direkt in der relativen URL angeben (z.B. ?user=abc&pwd=xyz).

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

Content bearbeiten…

Wird für den HTTP-Request ein Content erwartet, muss zunächst der Content-Type festgelegt werden. Ob und wie ein Content angegeben werden muss, wird üblicherweise in der API-Beschreibung detailliert beschrieben.

Content-Type (Datentyp String):
Die gängisten Content-Typen können aus der Liste ausgewählt werden (z.B. application/json). Sie können jedoch auch andere Content-Typen angegeben, welche nicht in der Liste enthalten sind.

Content

Die Eingabe des Contents unterscheidet sich je nach Content-Type:
“application/x-www-form-urlencoded”: Hier sind Name-Wert-Paare anzugeben (analog zu den Headern).
”application/json” und alle anderen Content-Typen erfordern eine Text-Eingabe in dem passenden Format:

Encoding:
Hier kann ein Encoding für text-basierte Content-Typen ausgewählt werden. Meist wird jedoch UTF-8 verwendet (siehe auch Encoding).

BOM hinzufügen:
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.

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 sie sofort in dieses Verzeichnis gespeichert 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.
Eine Übersicht der HTTP-Statuscode finden Sie z.B. unter https://developer.mozilla.org/de/docs/Web/HTTP/Status

Integer

Antwort

Der zurückgegebene Content aus der Http-Response.

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

String

Grund

Der Statuscode in Textform (nur im Eigenschaftenfenster)

Antwort-Header

Die Header aus der Http-Response (nur im Eigenschaftenfenster)
Wir empfehlen die Header nur mit einer Variable zu befüllen, wenn Sie sie auch benötigen, da ansonsten viele Daten anfallen können.

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