Prozess - Dialog-Schritte
Im Folgenden finden Sie eine (allgemeine) Übersicht über die einzelnen Schritte, die Sie ausführen müssen, wenn Sie einen API-Endpunkt anlegen. Den einzelnen Schritten entsprechen jeweils einzelne Dialog-Schritte in Intrexx. Nicht jeder Schritt ist für jeden Endpunkt erforderlich.
API-Endpunkte können oft auf verschiedene Weise erstellt werden. Manchmal kann beispielsweise dasselbe Resultat ausschließlich mit Pfad-Parametern, manchmal aber auch mit einer Kombination aus Pfad- und Query-Parametern erreicht werden. Daher dient die folgende Übersicht als Orientierung über häufig eingesetzte Vorgehensweisen.
|
Im ersten Dialog-Schritt werden Sie aufgefordert, einen Namen und eine Beschreibung für den Endpunkt zu erfassen. Titel und Beschreibung werden mit in die Swagger-Dokumentation übernommen, wenn Sie diese erzeugen. In diesem Dialog-Schritt wählen Sie zudem aus, welchen API-Endpunkt-Typ Sie erstellen möchten. Die folgenden Endpunkt-Typen stehen Ihnen zur Verfügung:
Die Auswahl des Endpunkt-Typs bestimmt auch, durch welche weiteren Dialog-Schritte Sie im weiteren Verlauf geführt werden; die Dialog-Schritte "Pfad-Parameter" und "Query-Parameter" werden bei allen Endpunkt-Typen angezeigt bzw. durchlaufen. Weitere Informationen zu den Endpunkt-Typen finden Sie in Abschnitt Endpunkt-Typen. |
|
Datengruppe-, Prozess-, Groovy-Skript-Auswahl Je nachdem, welchen Endpunkt-Typ Sie im Dialog-Schritt "Allgemein" ausgewählt haben, müssen Sie im nächsten Schritt entweder die gewünschte Datengruppe, den gewünschten Prozess oder das gewünschte Groovy-Skript auswählen. Außerdem legen Sie in diesem Dialog-Schritt fest, welche Methode Sie verwenden möchten. Beim Datengruppen-Endpunkt stehen Ihnen folgende Methoden zur Verfügung: GET, POST, PUT und DELETE. Beim Prozess- und Groovy-Endpunkt steht zusätzlich noch die Methode PATCH zur Verfügung. Schritt-für-Schritt-Anleitungen zum Anlegen von Datengruppen, Prozess- und Groovy-Skript-Endpunkten finden Sie in folgenden Abschnitten: |
|
Im Dialog-Schritt "Pfad-Parameter" müssen Sie mindestens einen Pfad-Parameter erfassen. Nähere Informationen zu Pfad-Parametern finden Sie in Abschnitt Pfad-Parameter definieren. |
|
Im nächsten Dialog-Schritt können Sie Query-Parameter definieren. Nähere Informationen zu Query-Parametern finden Sie in Abschnitt Query-Parameter definieren. |
|
Der Dialog-Schritt "Filter und Sortierung" wird ausschließlich angezeigt, wenn Sie einen Datengruppen-Endpunkt und dabei die Aktion "Mehrere Datensätze lesen" ausgewählt haben. Nähere Informationen zu Dialog-Schritt "Filter und Sortierung" finden Sie in Abschnitt Datensätze filtern und sortieren. |
|
Der Dialog-Schritt "Request JSON-Body" wird angezeigt, wenn Sie einen Datengruppen- oder Prozess-Endpunkt ausgewählt haben und dabei die Methoden POST, PATCH oder PUT einsetzen. Nähere Informationen zu Request JSON-Body finden Sie in Abschnitt JSON-Body definieren. |
|
Der Dialog-Schritt "Request JSON-Body" wird angezeigt, wenn Sie einen Datengruppen- oder Prozess-Endpunkt ausgewählt haben und dabei die Methoden GET, POST, PATCH oder PUT einsetzen. Nähere Informationen zu Response JSON-Body finden Sie in Abschnitt JSON-Body definieren. |
Übersicht über die folgenden Abschnitte
Die folgenden Abschnitte geben Ihnen zunächst noch einige allgemeine Informationen zu den drei verschiedenen Endpunkt-Typen und zum Aufbau der API-URL.
Anschließend finden Sie noch detaillierte Informationen zu den einzelnen Dialog-Schritten.
Senden Sie uns eine E-Mail