JSON-Body definieren

Je nach Endpunkt-Typ und der von Ihnen gewählten Methode haben Sie die Möglichkeit, einen Request JSON-Body oder einen Response JSON-Body zu erstellen. Bei manchen Methoden ist sowohl das Erstellen eines Request JSON-Body als auch eines Response JSON-Body möglich bzw. erforderlich.

Beispiel

Wenn Sie im Dialog-Schritt "Datengruppenauswahl" die Aktion "Mehrere Datensätze erstellen" oder "Datensatz ändern" gewählt haben, gelangen Sie nach den Definieren von Query-Parametern in den Dialog-Schritt "Request JSON-Body".

Klicken Sie auf das -Icon.

Wählen Sie die Datenfelder aus, für die Sie den JSON-Body erstellen möchten.

Die Vorschau für den JSON-Body wird angezeigt.

Name

Sie können den Namen des Parameters ändern.

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

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.

Beschreibung

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