Zum Ende der Metadaten springen
Zum Anfang der Metadaten

Sie zeigen eine alte Version dieser Seite an. Zeigen Sie die aktuelle Version an.

Unterschiede anzeigen Seitenhistorie anzeigen

« Vorherige Version anzeigen Version 8 Nächste Version anzeigen »

Konfiguration der REST-Page

Als Endpunkte für die RESTful API dienen Pages. Diese können in brandbox angelegt und konfiguriert werden. Es gibt keine andere Möglichkeit, Daten über RESTful zu verarbeiten.

  • Legen Sie einen Datensatz in , um eine Page zu definieren
FeldBeschreibung
NameDer Name der Page
IdentifierEin eindeutiger Identifikator, der für den Endpunkt verwendet wird
ServiceDer Service, der die gemappten Daten verarbeiten soll
Mapping-ProfileDie zugewiesenen Mapping-Profile
Endpunkt-URLDie URL des Endpunkt für die Page. Wird automatisch befüllt
FilterEin Filter, der im Service Liste auf die Ergebnisse angewendet wird

Mapping-Profile

Über Mapping-Profile werden die Felder einer Tabelle definiert, die eine REST-Page verarbeiten kann. Dies dient einerseits zur Verschleierung der nicht notwendigen Felder nach außen, als auch zur Erhaltung der Kompatibilität bei Feld-Änderungen durch ein brandbox-Update.
Datenbezogene REST-Pages können nicht ohne Mapping funktionieren.

  • Legen Sie einen Datensatz in  an, um ein Mapping-Profil zu definieren
FeldBeschreibung
NameDer Name der Map
TypDie Tabelle, aus der Daten gemapped werden sollen
Unterstützte Http-Request-MethodenDie von der Map unterstützten Http-Request-Methoden

Es kann notwendig sein, für unterschiedliche Http-Request-Methoden unterschiedliche Mapping-Profile zu verwenden. Bspw. möchte man beim Auslesen einer Datensatzliste den Inhalt von 10 bestimmten Feldern zurückgeben, für das Schreiben eines Datensatzes aber nur 5 dieser Felder erlauben. Durch die Definition zweier unterschiedlicher Mapping-Profile für die Request-Typen GET und DELETE lässt sich dies konfigurieren.

Map befüllen

Um nicht für jede Map alle gewünschten Felder immer wieder manuell anlegen zu müssen, steht eine Funktion bereit, die diese Aufgabe übernimmt. Es werden automatische alle Felder der gewählten Tabelle mit dem Feld-Identifier als Label angelegt und zur Map verknüpft. Nicht gewünschte Felder können dann manuell entfernt werden.

  • Legen Sie eine Map in an und speichern Sie
  • Klicken Sie in der Toolbar auf Map befüllen
  • Bestätigen Sie

Die Felder der gewählten Tabelle werden automatisch als Map-Datensätze angelegt und an die Map verknüpft. Auf Wunsch können natürlich in der Tabelle  Map-Datensätze manuell angelegt und verknüpft werden.

  • Keine Stichwörter