Versionen im Vergleich

Schlüssel

  • Diese Zeile wurde hinzugefügt.
  • Diese Zeile wurde entfernt.
  • Formatierung wurde geändert.

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 

    an, um eine Page zu definieren

Feld

Beschreibung

Name

Der Name der Page

Identifier

Ein eindeutiger Identifikator, der für den Endpunkt verwendet wird

Typ

Service

Der

Typ von Daten

Service, der die

die Page

gemappten Daten verarbeiten soll

MapsDie zugewiesenen Mappings

ETL Maps

Über ETL Maps 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 eine ETL Map zu definieren
FeldBeschreibungNameDer Name der MapTypDie Tabelle, aus der Daten gemapped werden sollen

Mappingprofil

Das zugewiesene Mappingprofil

Unterstützte Http-Request-Methoden

Die von der Map unterstützten Http-

Request-Methoden

Es kann notwendig sein, für unterschiedliche Http-Request-Methoden unterschiedliche Maps 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 Maps 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

...

aus GET, POST, PUT, DELETE, die die Page unterstützt

Endpunkt-URL

Die URL des Endpunkt für die Page. Wird automatisch befüllt

Filter

Ein Filter, der im Service Liste auf die Ergebnisse angewendet wird

Mapping-Profile

Lesen Sie hier weiter Mappingprofile.