Query-Parameter definieren

Query-Parameter werden im Dialog-Schritt "Query-Parameter" definiert.

Nicht immer ist das Erstellen eines Query-Parameters erforderlich.

Klicken Sie auf , um einen neuen Query-Parameter zu definieren.

Query-Parameter-Typen

Welche Query-Parameter-Typen Sie anlegen können, hängt davon ab, welche Aktion bzw. Methode Sie im Dialog-Schritt Datengruppenauswahl ausgewählt haben.

Statische Query-Parameter

Einen statischen Query-Parameter können Sie immer anlegen.

1. Klicken Sie auf "Statisch".

   

2. Erfassen Sie im Feld "Name" einen Namen.

   Der Name muss mindestens zwei Zeichen lang sein und mit einem Kleinbuchstaben beginnen. Zudem darf er nur alphanumerische Zeichen und Unterstriche enthalten.

Query-Parameter mit Datenfeldzuordnung

Klicken Sie auf "Datenfeld", um einen Query-Parameter mit (unmittelbarer) Datenfeldzuordnung anzulegen.

Wählen Sie anschließend das gewünschte Datenfeld aus.

Name

Erfassen Sie hier einen Namen für den Parameter.

Der Name darf in einem Endpunkt nur einmal vorkommen.

Der Name muss dem regulären Ausdruck [a-zA-Z][a-zA-Z\\d-_.]+ entsprechen. D.h. er muss mindestens zwei Zeichen lang sein und mit einem Buchstaben beginnen. Es sind nur Buchstaben, Zahlen, Minus, Unterstriche und Punkte erlaubt.

Datentyp

Wählen Sie hier den Datentyp des Pfad-Parameters aus.

Der Datentyp des eingehenden Pfad-Parameters muss mit dem hier gewählten Datentyp übereinstimmen. Wenn die Datentypen nicht übereinstimmen, wird der entsprechende Request nicht verarbeitet.

Fallback

Hier können Sie einen Fallback-Wert für den Parameter hinterlegen.

Der Fallback-Wert kommt zum Tragen, wenn der Parameter auf jeden Fall ausgewertet werden soll und gleichzeitig ein Wert für den Parameter beim Aufrufen des Endpunkts nicht zwingend mitgegeben werden muss.

Parameter ist erforderlich

Wenn Sie das Kontrollkästchen aktivieren, ist der Parameter für den Request zwingend anzugeben.

Das Aktivieren des Kontrollkästchens kann u.a. dann hilfreich sein, wenn ein Parameter auf jeden Fall erwartet wird, ein sinnvoller Fallback aber nicht definiert werden kann (beispielsweise eine Benutzer-ID).

Beschreibung

Erfassen Sie hier eine Beschreibung für den Parameter. Mehrzeilige Texte sind möglich. Die Beschreibung ist Bestandteil der Swagger Dokumentation.