Es wird zwischen den zu übertragenden und den zu empfangenden Daten unterschieden.
Der Client bestimmt über HTTP-Header über die Parameter content-type und accept in welchem Format er Daten sendet und in welchem er Daten empfängt.
Wird kein oder kein bekanntes Empfangs-Format übergeben wird als Standard JSON zurückgegeben.
Gültige Formate sind:
Attribut | Senden: content-type | Empfang: accept | Info | ||||||
|---|---|---|---|---|---|---|---|---|---|
application/x-www-form-urlencoded | x | - | Daten URL-Encoded | ||||||
application/json | x | x | Daten in JSON | ||||||
application/xml | x | x | Daten in XML, erst experimentell verfügbar zum Lesen von Daten | ||||||
application/octet-stream Wird nur akzeptiert, wenn ein einziges binäres Feld gelesen, eingefügt oder aufdatiert werden soll. | x | x | Binäre Daten, in Entwicklung | ||||||
text/plain | - | x | Formatierte Felder werden als Text ausgegeben. Felder können intern in RTF oder HTM formatiert gespeichert sein. In der REST-Schnittstelle ist dies nicht immer erwünscht. Mit dieser Option werden die Daten als unformatierter Text ausgegeben. | ||||||
| [ fullmeta | nometa | compact ] | automatische Erkennung | x | Das auszuliefernde Datenformat kann angegeben werden:
Bei der Annahme von Daten erkennt der Server das Format automatisch. |
Die Sende- und Empfangs-Format sind frei kombinierbar, ebenso gewisse accept-Optionen untereinander.
Bsp. Ausgabe in JSON und Konvertierung formatierter Texte in reinen Text:
accept: application/json;text/plain;compact
Falls sprachabhängige Daten zurückgegeben werden, kann die zu verwendende Sprache über den http-Header accept-language gesteuert werden.
Gültige Werte im Standard sind de, fr, it, en. Es können je nach Projekt auch andere Werte freigegeben werden.
Wird keine Sprache angegeben, wird der Systemstandard verwendet. In der Regel ist das de.
Attribut | Senden: accept-language | Empfang: - | Info |
|---|---|---|---|
[de, fr, it, en] | x | - | Sprachkürzel in der die Antwort erwartet wird |
Bezeichnung der Datentypen
In den Felddefinitionen werden folgende Datentypbezeichner verwendet:
| Bezeichner | Beschreibung |
|---|---|
| num | Numerischer Wert |
| int | Integer |
| bool | Boolscher Wert, 1|0 oder True|False |
| ref | Integer , Referenzwert zu einer anderen Entität |
| key | Integer, Primärschlüssel |
| string | Zeichenkette |
| bin | Binärdaten, base64 codiert |
| ak | Als Zusatz, Alternativschlüssel, muss eindeutig innerhalb der Tabelle sein |
Die maximale Länge wird in eckigen Klammern angegeben:
| Format | Beschreibung |
|---|---|
| string[40], ak | Zeichenkette maximal 40 Zeichen, Alternativschlüssel |
| num[6,2] | Numerischer Wert, total 6 Stellen, 2 Präzision Nachkommastellen. |
| bin[50k] | Binärdaten, maximal 50 kB Rohdaten, muss base64 codiert sein. |
Lesen von Views
In Views können Daten aus unterschiedlichen Entitäten aufbereitet und in einer denormalisierten Form und/oder in einer hierarchischen Form ausgegeben werden. Felder der Sublisten werden mit „->“ angegeben.
Views können nur gelesen werden. Alle View-Abfragen haben die Pfad-Erweiterung /view.
View-Abfragen können mit Filter eingeschränkt werden. Folgende Filtertypen sind vorhanden:
| Filter | Beschreibung |
|---|---|
| EP | Einzelwert, Pflichtfilter, z.B. die ID |
| EO | Einzelwert, optional, z.B. DatumVon |
| ET | Einzelwert, optional, sucht den Filtertext innerhalb des Feldes (techn. contains, like etc.) |
| M | Mehrfachwerte oder gar keine Werte, optionaler Filter |