Erstellung von API-Methoden für Vorgänge
Klicken Sie im Menü „Einstellungen“ auf „API-Designer“ > Klicken Sie mit der rechten Maustaste auf „API für Vorgänge“ > „API hinzufügen“
Methode.
Der entsprechende Bereich ist aktiviert:
Geben Sie die Eigenschaften der API-Methode an und bestätigen Sie anschließend durch Klicken auf die Schaltfläche „Validieren“.
Sie weist folgende Merkmale auf:
Name:
Dieses Feld ist ein Pflichtfeld; es ermöglicht es, der Methode einen Namen zu geben. Es wird empfohlen, der Methode einen eindeutigen Namen zu geben.
Beschreibung:
Geben Sie der Methode eine Beschreibung. Diese Angabe ist optional.
Verlauf:
Hier werden das Erstellungsdatum und die Erstellungszeit sowie die letzte Änderung am Kontext zusammen mit dem Anwendernamen des Anwenders angezeigt, der diese Aktionen durchgeführt hat.
Diese Eigenschaft wird automatisch aktualisiert.
HTTP-Methode
Die Auswahl der Methode ist obligatorisch.
Durch die Wahl zwischen GET, PUT bzw. POST können Sie eine Methode zum Lesen, Ändern oder Anlegen eines Vorgangs erstellen.
UPSERT-Modus
Das Feld „UPSERT-Modus“ ist optional und erscheint nur bei Verwendung der HTTP-POST-Methode. Es steht nicht zur Verfügung, wenn ein untergeordneter Vorgang erstellt wird (Kontrollkästchen „Untergeordneter Vorgang“ aktiviert).
Sie ermöglicht es Ihnen, Schlüssel zur Identifizierung von Vorgängen zu definieren, wodurch Sie diese erstellen oder ändern können (ein Prinzip, das sich aus dem Import von Vorgängen ableitet).
Es ist zudem möglich, übergeordnete Schlüssel zu definieren, um übergeordnete Vorgänge zu identifizieren.
Die Angabe von übergeordneten Schlüsseln ist nur im Falle einer vertikalen Hierarchie sinnvoll und anwendbar.
Attribute
Wählen Sie die Attribute (Rubriken für Ressourcen oder Attribute der Vorgänge) aus, die je nach gewählter HTTP-Methode gelesen, geändert oder bei der Erstellung berücksichtigt werden sollen.
Um den Editor aufzurufen und Attribute auszuwählen, klicken Sie auf die Schaltfläche.
Für die HTTP-Methode „GET“ erscheint das folgende Fenster:
Die Spalte „Eigenschaft“ entspricht dem Namen der ausgewählten Rubrik.
Die Spalte „Modus“ entspricht der Bezeichnung dieser Rubrik, die im Hauptteil der Antwort (Response Body) auf eine Leseanfrage (HTTP-GET-Methode) erscheint.
Wichtig:
Die angezeigte Bezeichnung muss den folgenden Regeln entsprechen, andernfalls wird sie rot markiert
Bei Auswahl:
- Es werden ausschließlich Kleinbuchstaben akzeptiert,
- Der Unterstrich (_) wird akzeptiert,
- Sollte die Bezeichnung Zahlen enthalten, müssen diese Zahlen am Ende der
label.
Bei Verwendung der HTTP-Methoden PUT oder POST (ohne aktivierten UPSERT-Modus) erscheint das folgende Fenster:
Die Spalte „Eigenschaft“ entspricht dem Namen der ausgewählten Rubrik.
Die Spalte „Modus“ gibt den Eingabemodus eines Werts an:
- Wenn „Modus“ = „Wert“: Die Spalte „Variable“ oder „Wert“ enthält einen konstanten Wert, der
nicht konfigurierbar und wird zur Erstellung oder Änderung verwendet
- Wenn „Modus“ = „Variable“ ist: Die Spalte „Variable“ oder der Wert entspricht der Bezeichnung dieser
Rubrik, die konfigurierbar ist und wie folgt angezeigt wird:
- Im Hauptteil (Request-Body), der die Unterstützungsdaten für die Erstellung beschreibt (HTTP
(POST-Methode)
- Im Hauptteil (Request Body), der die zu ändernden Daten beschreibt (HTTP-PUT
(Methode).
Die Auswahl eines Attributs erfolgt über die Schaltfläche.
Filter:
Dieses Feld ist optional und erscheint nur bei Verwendung der HTTP-GET-Methode.
Sie ermöglicht es Ihnen, einen Filter auf die Lesemethode anzuwenden.
Hinweis:
Die Verwendung dynamischer Filter: Um einen dynamischen Filter anzuwenden, klicken Sie bitte auf den Bleistift neben „Zu erfragen“ und fügen Sie eine Variable ein.
Untergeordneter Vorgang
Dieses Feld erscheint nur bei Verwendung der HTTP-POST-Methode.
Damit können Sie eine Methode zum Anlegen eines untergeordneten Vorgangs erstellen. Aktivieren Sie in diesem Fall diese Schaltfläche.
REST Anfrage
Beispiel für eine HTTP-GET-Methode
In diesem Fenster werden die für die API-Methode vorgenommenen Einstellungen beschrieben:
- URL: Bezeichnung der aufzurufenden URL.
- Header: Attribut-Wert-Paar, das in den Methoden-Header eingefügt werden soll (z. B.: der API-Schlüssel apikey).
- Parameter: Dies sind die Parameter der API-Methode. Sie sind nur in der
Im Falle einer HTTP-GET-Methode, die den Filter „dynamic“ verwendet, entsprechen diese den Variablen dieses Filters.
- Antworttext: Datenstruktur im Format JSON, die von der read-Methode zurückgegeben wird.
Beispiel für eine HTTP-PUT- oder POST-Methode
In diesem Fenster werden die für die API-Methode vorgenommenen Einstellungen beschrieben:
- URL: Bezeichnung der aufzurufenden URL.
- Header: Attribut-Wert-Paar, das in den Methoden-Header eingefügt werden soll (z. B.: der API-Schlüssel apikey).
- Antworttext: Datenstruktur im Format JSON, die als Hauptteil der Erstellungsanfrage (POST) verwendet wird
oder die Methode zur Änderung (PUT).
Die Verwendung einer Warnungsbeschränkung
Bei Verwendung der PUT- oder POST-Methode kann ein Vorgang geändert werden, wenn seine Auslösebedingung die Einschränkung erfüllt. Aktivieren Sie dazu das Kontrollkästchen „Erstellen erzwingen“.
Anpassung einer API-Methode für Vorgänge
Um eine API-Methode für Vorgänge anzupassen, gehen Sie zum Menü „Einstellungen“ > „API-Designer“ > „API auswählen“
Methode zur Änderung von Vorgängen.
Das entsprechende Fenster wird angezeigt.
Ändern Sie die Eigenschaften und klicken Sie anschließend auf die Schaltfläche „Validieren“, um die API-Methode für Vorgänge zu speichern.
Löschen einer API-Methode für Vorgänge
Um eine API-Methode für Ressourcen zu löschen, gehen Sie zum Menü „Einstellungen“ > „API-Designer“ > Klicken Sie mit der rechten Maustaste auf
Die API-Methode zum Löschen von Vorgängen > „Delete“.
Das folgende Fenster wird angezeigt:
Klicken Sie auf:
- „Ja“, um den Löschvorgang zu bestätigen,
- „Nein“, um den Löschvorgang abzubrechen.
Duplizieren einer API-Methode für Vorgänge
Um eine API-Methode für Vorgänge zu duplizieren, gehen Sie zum Menü „Einstellungen“ > „API-Designer“ > Klicken Sie mit der rechten Maustaste auf
Die API-Methode zum Duplizieren von Vorgängen > Duplicate
Nehmen Sie die erforderlichen Änderungen vor und klicken Sie auf „Validieren“, um diese zu speichern.
