Tabellen, Felder und Datensätze

aktualisiert vor 11 Tagen

Abfrageparameter und allgemeine Attribute zum Abfragen von Datensätzen mit der Ninox-API

Tabellen

Beim Abrufen von Daten für Tabellen mithilfe einer GET-, POST- oder DELETE-Anfrage listet der Antwortkörper alle verfügbaren Tabellen sowie Tabellendefinitionen auf. Jedes Element in einer Antwort besteht aus drei Eigenschaften, die eine Tabelle definieren: eine ID, ein Name und Felder.

Tabellen-IDs beginnen mit A, B, … AA, AB usw. und müssen für GET-, Update- oder DELETE-Anfragen angegeben werden. Ein Tabellenname ist ein menschenfreundlicher Name für eine bestimmte Tabelle. Felder sind Arrays von Objekten, die jeweils eine Spalte in der Tabelle beschreiben.

Felder

Jedes Feld wird durch eine ID, einen Namen und einen Feldtyp definiert. Feld-IDs beginnen mit A, B, … AA, AB usw. Ein Feldname ist ein menschenfreundlicher Name für ein bestimmtes Feld. Informationen zu Feldtypen finden Sie in der Tabelle unten.

Feldtypen

Feldtyp	JSON-Typ	Beispiel
text	string	`"Lisa"`
number	number	`13.42`
date	string	`"2021-01-23"`
datetime	string	`"2021-01-23T12:30:00"`
timeinterval	string	`"123:25:16.123"`
time	string	`"12:30:00"`
appointment	string	`"2021-01-23T12:30:00 - 2021-01-23T13:30:00"`
boolean	boolean	`true false`
choice	string	`"blue"`
url	string	`"https://ninox.com"`
email	string	`"support@ninox.com"`
phone	string	`"+1 123456789"`
location	string	`"Monbijouplatz 5, 10178 Berlin, Germany <52.5330804,13.3972939>"`
html	string	`"<h1>Hello</h1>"`

Tabellen- und Feld-IDs ändern sich während der Lebensdauer einer Datenbank nicht. Eine Tabellen- oder Feld-ID ist ein Handle, auch bekannt als opaker Bezeichner. Das ID-Format kann sich in zukünftigen Ninox-Versionen ändern.

Allgemeine Attribute

Jeder Datensatz hat die folgenden allgemeinen Attribute:

Attribute

Attribut	JSON-Typ	Beschreibung	Beispiel
`id`	integer	Die Datensatz-ID, beginnend mit 1	`5`
`sequence`	integer	Die Änderungssequenznummer der Datenbank, als der Datensatz zuletzt aktualisiert wurde	`47`
`createdAt`	string	Der UTC-Zeitstempel, als der Datensatz erstellt wurde Format: `YYYY-MM-DDThh:mm:ss`	`"2021-09-13T18:24:26"`
`createdBy`	string	Die ID des Benutzers, der den Datensatz erstellt hat	`"root"`
`modifiedAt`	string	Der UTC-Zeitstempel, als der Datensatz aktualisiert wurde Format: `YYYY-MM-DDThh:mm:ss`	`"2021-09-14T07:53:12"`
`modifiedBy`	string	The id of the user who modified the record	`"root"`

YYYY-MM-DDThh:mm:ss

"2021-09-15T16:04:19"

fields

Objekt Ein Objekt mit allen Datenfeldern; der Feldname wird als Schlüssel verwendet

"First name": "Anna"

Abfrageparameter

Die folgenden Abfrageparameter steuern, welche und wie viele Datensätze zurückgegeben werden, wenn Datensätze mit einer GET- oder POST-Anfrage abgerufen werden.

Parameter

Parameter	JSON-Typ	Beschreibung	Standardwert	Beispiel
`query`	string	Ninox-Skript, das ausgeführt werden soll	n/a	`(select Contact).'Email'`
`filters`	string	Stringifizierte JSON, die Kriterien enthält	n/a	`"A":"support@ninox.com"`
`page`	integer	Ergebnis-Seite	`0`	`12`
`perPage`	integer	Datensätze pro Seite	`100`	`250`
`order`	string	Der Feldname, nach dem das Ergebnis geordnet wird	n/a	`"First name"`
`desc`	boolean	Absteigende Reihenfolge	`false`	`true`
`new`	boolean	Zeige die neuesten Datensätze zuerst Kann nicht mit der Reihenfolge kombiniert werden	`false`	`true`
`updated`	boolean	Zeige die neuesten Aktualisierungen zuerst Kann nicht mit der Reihenfolge kombiniert werden	`false`	`true`
`sinceId`	integer	Zeige nur Datensätze mit einer höheren ID	n/a	`42`
`sinceSq`	integer	Zeige nur Datensätze, die nach der angegebenen Datenbank-Änderungssequenznummer erstellt oder aktualisiert wurden	n/a	`1567`
`ids`	boolean	Formatiert die Datensätze entweder als Feld-Id-Wert oder als Feldname-Wert	n/a	`true` `false`
`choiceStyle`	string	Formatiere das Auswahlfeld in einem Datensatz entweder als Option-Id oder als Bezeichnung einer ausgewählten Option	ids	ids names

Beim Filtern von Datensätzen, kodieren Sie den Pfadparameter mit der encodeURIComponent()-Funktion in JavaScript.

Beispiel

Vor der Kodierung, eine JSON-Zeichenkette, die folgendes enthält:
(select Contact).'Email'
Nach der URI-Kodierung wird daraus:
%28select%20Contact%29.%27Email%27