Endpunkt - Mehrere Datensätze lesen

Schritt-für-Schritt

Um einen API-Endpunkt für die Aktion "Mehrere Datensätze lesen" zu erstellen, gehen Sie wie folgt vor:

  1. Klicken Sie auf (Neuen Endpunkt erstellen).

    Sie gelangen auf den Dialog-Schritt "Allgemein".

    Name

    Erfassen Sie hier einen Namen für den Endpunkt.

    Der Name muss eindeutig sein, mindestens aus zwei Zeichen bestehen und mit einem Buchstaben beginnen. Erlaubt sind dabei nur alphanumerische Zeichen, Bindestriche, Unterstriche und Punkte.

    Beschreibung

    Erfassen Sie hier eine Beschreibung für den Endpunkt. Mehrzeilige Texte sind möglich.

  2. Klicken Sie auf "Datengruppen-Endpunkt".

  3. Klicken Sie auf "Weiter".

    Sie gelangen auf den Dialog-Schritt "Datengruppenauswahl".

Endpunkt

Hier wird die Methode des Endpunkts und der fixe Teil des Endpunktpfads angezeigt.

Hinweis Sie können die Methode bzw. die Aktion ändern, indem Sie auf die Methode klicken und anschließend eine andere Aktion auswählen.

Aktion

Wählen Sie "Mehrere Datensätze lesen" aus.

Im oberen Bereich des Fensters wird unterhalb von "Endpunkt" die Methode GET und der erste Teil des Pfades angezeigt.

Applikation

Wählen Sie die gewünschte Applikation aus.

Datengruppe

Wählen Sie die gewünschte Datengruppe aus.

Rückgabewerte der Anfrage

Hier legen Sie fest, welche Werte der Endpunkt zurückgeben soll.

Standardmäßig (außer bei "Datensatz löschen") ist der PK (Primary Key) des Datensatzes als Rückgabewert bereits hinzugefügt.

    1. Klicken Sie auf , um weitere Rückgabewerte hinzuzufügen.

      Alle Datenfelder auswählen/entfernen Sie können im Dialog "Datenfelder hinzufügen" die rechte Maustaste betätigen. Anschließend wird ein Fenster angezeigt, über das Sie alle Datenfelder hinzufügen oder entfernen können.

       

      Rückgabewerte entfernen Sie können Rückgabewerte direkt entfernen, indem Sie auf das X klicken, das neben einem Rückgabewert angezeigt wird, sobald Sie die Maus darüber platzieren.

      Name, Beschreibung

      Wenn Sie auf einen Rückgabewert klicken, wird im rechten Bereich der Name des Rückgabewertes angezeigt.

      Aus Wiki: Da hier JSON-konforme Bezeichner benötigt werden, kann der Feld-Name überschrieben werden.

      Den Namen des Rückgabewertes können Sie ändern. Der Name muss mindestens zwei Zeichen lang sein und mit einem Kleinbuchstaben beginnen. Zudem darf er nur alphanumerische Zeichen und Unterstriche enthalten.

    2. Klicken Sie auf "Weiter".

      Sie gelangen in den Dialog-Schritt "Pfad-Parameter".

    • Auf dieser Seite können Sie Pfadparameter für den Endpunkt definieren.

    Allgemeine Erläuterungen zum Definieren von Pfad-Parametern finden Sie in Abschnitt Pfad-Parameter definieren.

    1. Klicken Sie auf .

      Die Optionen "Variabel" und "Statisch" werden angezeigt.

    2. Klicken Sie auf "Variabel", wenn einen variablen Pfad-Parameter anlegen möchten.

      Klicken Sie auf "Statisch", wenn Sie einen statischen Pfad-Parameter anlegen möchten.

      In den folgenden Schritten wird davon ausgegangen, dass Sie einen statischen Pfad-Parameter anlegen.

      Die Eingabefelder für das Definieren des Pfad-Parameters sind aktiv.

      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.

      Variabler Parameter

      Wenn Sie dieses Kontrollkästchen aktivieren, wird der statische Pfad-Parameter zu einem variablen Pfad-Parameter.

      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.

      Beschreibung

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

    3. Klicken Sie auf "Weiter".

      Sie gelangen in den Dialog-Schritt "Query-Parameter".

    Auf dieser Seite können Sie Query-Parameter für den Endpunkt definieren.

    Detaillierte Informationen zu Query-Parametern finden Sie unter folgenden Links:

    1. Klicken Sie auf .

      Die Eingabefelder für das Definieren von Query-Parametern sind aktiv.

      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.

    2. Klicken Sie auf "Weiter".

      Sie gelangen in den Dialog-Schritt "Filter und Sortierung".

     

    1. Klicken Sie auf .

      Der Dialog "Eigenschaften des Filterausdrucks" wird angezeigt.

      Im Folgenden werden die relevanten Felder beschrieben.

       

      Datengruppe

      Wählen Sie hier die Datengruppe aus, der der Query-Parameter zugeordnet werden soll.

      Datenfeld

      Wählen Sie hier das Datenfeld aus, das dem Query-Parameter zugeordnet werden soll.

      Binding

      Hier wählen Sie den Query-Parameter aus.

      Klicken Sie auf .

      Sie gelangen in den Dialog "Eigenschaften des Bindings".

      Wählen Sie links die Option "Parameter (Application API)" aus.

      Wählen Sie rechts unterhalb von "Parameter (Application API)" den gewünschten Parameter aus.

      Klicken Sie auf "OK".

      Sie gelangen zurück in den Dialog "Eigenschaften des Filterausdrucks".

      Klicken Sie auf "OK".

      Sie gelangen zurück in den Dialog-Schritt "Filter und Sortierung".

    2. Klicken Sie auf "Fertigstellen".

    Der erzeugte Endpunkt wird im Bereich "API-Endpunkte" angezeigt.

    Ihre nächsten Schritte

    In der Regel müssen Sie nach dem Erstellen des API-Endpunkts die folgenden Aktionen ausführen, um den API-Endpunkt ausführen zu können.

    1. Berechtigungen vergeben

    2. API-Keys erstellen und verwalten

    3. Swagger-Dokumentation erzeugen