DOCLimbasREST

From Limbas Wiki

Jump to: navigation, search
Note: Dieses Feature erscheint in Version 4.0.

Funktionen

Daten Abfragen

Es werden drei URL-Struktur-Typen unterstützt:

  1. Abfrage auf gesamte Tabelle: GET /tabellenname
  2. Abfrage auf einzelnen Datensatz: GET /tabellenname/datensatz-id
  3. Abfrage auf verknüpfte Datensätze eines Datensatzes: GET /tabellenname/datensatz-id/verknüpfungsfeld

Pagination

Erfolgt über den Parameter page:

  • page[count] legt fest, wie viele Datensätze pro Seite zurückgegeben werden.
  • page[number]> legt fest, welche Seite zurückgegeben werden soll.

Wird der Parameter weggelassen, werden alle Datensätze zurückgegeben.

Beispiel: GET /kontakte?page[count]=20&page[number]=3 teil das Ergebnis in Seiten von jeweils 20 Datensätzen auf und gibt Seite 3 zurück.

In der Antwort des Servers werden verwandte Seiten (first, prev, next, last) unter dem Toplevel Eintrag links nach dem HATEOAS-Prinzip angezeigt.

Felder begrenzen

Erfolgt über den Parameter fields. Wird dieser nicht gesetzt, werden alle Felder der aktiven Tabelle zurückgegeben. Mögliche Syntaxen:

  • fields=feld1,feld2: Es werden nur die Felder name und vorname zurückgegeben (Tabelle implizit durch URL definiert)
  • fields[tabellenname]=feld1,feld2: Gleiche Bedeutung, Tabelle explizit definiert
  • fields[tabellenname]=*: Alle Felder der Tabelle

Sortierung

Erfolgt über den Parameter sort. Syntax:

  • sort=feld1,-feld2: Sortiert zuerst nach feld1 (aufsteigend), dann nach feld2 (absteigend)
  • sort=tabellenname.feld1,-tabellenname.feld2: Gleiche Bedeutung, Tabelle explizit definiert