Pfad-Parameter definieren

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

Mindestens ein Pfad-Parameter

Eine API-URL muss mindestens einen Pfad-Parameter enthalten.

Als (ersten) Pfad-Parameter können sich statische, aussagekräftige Pfad-Parameter anbieten.

Klicken Sie auf das -Icon, um einen neuen Pfad-Parameter zu definieren.

Pfad-Parameter-Typen

Folgende Pfad-Parameter(-typen) können generell definiert werden:

Statische Pfad-Parameter

Beispiel

/api/app/1A2B3C4D5E/v1

Bei statischen Pfad-Parametern erfolgt keine Zuordnung zu einem Datenfeld.

Über einen statischen Pfad-Parameter können Sie beispielsweise die Application API versionieren, indem Sie "v1" oder einen vergleichbaren Namen vergeben.

  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.

Variable Pfad-Parameter

Beispiel

/api/app/1A2B3C4D5E/{store-id}

  1. Variable Pfad-Parameter mit "unmittelbarer" Datenfeldzuordung

    Bei allen Aktionen außer "Mehrere Datensätze lesen" steht im Dialog "Pfad-Parameter" ein Auswahldialog zur Verfügung, mit dem Sie den Pfad-Parameter einem Datenfeld zuordnen können.

    Klicken Sie auf "Datenfeld" und wählen Sie anschließend das gewünschte Datenfeld aus.

  2. Variable Pfad-Parameter mit Datenfeldzuordung über den Filterdialog

    Bei der Aktion "Mehrere Datensätze lesen" müssen Sie im Dialog-Schritt "Pfad-Parameter" zunächst nur einen Namen für den Parameter vergeben und einen Datentyp auswählen.

    Das Zuordnen des Pfad-Parameters zu einem Datenfeld erfolgt im Dialog-Schritt "Filter und Sortierung".

    Detaillierte Angaben hierzu finden Sie in folgenden Abschnitten:

Allgemeine Informationen zu Pfad-Parametern