Erstellung von API-Methoden für Ressourcen
Klicken Sie im Menü „Einstellungen“ auf „API-Designer“ > Klicken Sie mit der rechten Maustaste auf „API für Ressourcen“ > Wählen Sie „API hinzufügen“
Vorgehensweise > Wählen Sie eine Dimension aus:
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 einer Ressource erstellen.
UPSERT-Modus
Das Feld „UPSERT-Modus“ ist optional und erscheint nur bei Verwendung der HTTP-POST-Methode.
Sie dient dazu, Schlüssel zur Identifizierung von Ressourcen zu definieren, wodurch diese angelegt oder geändert werden können (ein Prinzip, das aus dem Ressourcenimport abgeleitet ist).
Attribute
Wählen Sie die Attribute (Rubriken für Ressourcen) 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:
Bei einer HTTP-POST-Methode mit aktiviertem 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).
Für die Spalte „Schlüssel?“ gibt es mehrere mögliche Fälle:
- Wenn kein Element als Schlüssel markiert ist, wird eine neue Ressource angelegt.
- Wenn ein oder mehrere Felder als „Schlüssel“ markiert sind:
- Wenn eine oder mehrere Ressourcen identifiziert wurden, werden diese aktualisiert,
- Wurde keine Ressource identifiziert, wird eine neue Ressource angelegt.
Die Auswahl eines Attributs erfolgt über die Schaltfläche.
Wichtig:
Bestimmte Rubriken, sogenannte „formatierte Wert-Rubriken“, können bei einem API-Aufruf für PUT- und POST-Anfragen nicht aufgerufen werden. Dabei handelt es sich um die folgenden Rubriken:
- Zähler
- Funktionsweise
- Bewertungsposten
- Steuerspalte
- Berechnetes Datum
- Verkettung von Text
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:
Dieses Feld ist optional und erscheint nur bei Verwendung der HTTP-GET-Methode.
Sie ermöglicht es Ihnen, einen Filter auf die Lesemethode anzuwenden.
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.
- Kopfzeile: Attribut-Wert-Paar, das in die Methoden-Kopfzeile eingefügt werden soll (z. B.: der API-Schlüssel
"apikey").
