API-Endpunkte für Public Cloud
In diesem Artikel
Alle verfügbaren Ninox Public Cloud API-Endpunkte
In geschweiften Klammern
{ }
stehender Inhalt stellt einen Platzhalter dar. Sowohl die geschweiften Klammern als auch der Inhalt darin müssen ersetzt werden, damit die Anfrage funktioniert.
Mehrere Arbeitsbereiche abrufen
GET
https://api.ninox.com/v1/teams
Ruft Daten von mehreren Teams ab.
Header
Name | Typ | Beschreibung |
---|---|---|
Authorization* | string | Bearer {accessToken} |
Content-Type | string | application/json |
200 Die Arbeitsbereich-IDs und -Namen werden in der Antwort angezeigt.
Beispielanfrage
Einen einzelnen Arbeitsbereich abrufen
GET
https://api.ninox.com/v1/teams/{teamid}
Ruft Daten von einem einzelnen Team ab.
Pfadparameter
Name | Typ | Beschreibung |
---|---|---|
teamid* | string | Arbeitsbereich-ID |
Header
Name | Typ | Beschreibung |
---|---|---|
Authorization* | string | Bearer {accessToken} |
Content-Type | string | application/json |
200 Die Arbeitsbereich-ID und der Name werden in der Antwort angezeigt.
Beispielanfrage
Mehrere Datenbanken abrufen
GET
https://api.ninox.com/v1/teams/{teamid}/databases
Ruft Daten von mehreren Datenbanken ab.
Pfadparameter
Name | Typ | Beschreibung |
---|---|---|
teamid* | string | Arbeitsbereich-ID |
Header
Name | Typ | Beschreibung |
---|---|---|
Authorization* | string | Bearer {accessToken} |
Content-Type | string | application/json |
200 Die Datenbank-ID und der Name werden in der Antwort angezeigt.
Beispielanfrage
Schema einer einzelnen Datenbank abrufen
GET
https://api.ninox.com/v1/teams/{teamid}/databases/{dbid}
Ruft das Schema einer einzelnen Datenbank ab.
Pfadparameter
Name | Typ | Beschreibung |
---|---|---|
teamid* | string | Arbeitsbereich-ID |
dbid* | string | Datenbank-ID |
Header
Name | Typ | Beschreibung |
---|---|---|
Authorization* | string | Bearer {accessToken} |
Content-Type | string | application/json |
200 Die Schema-Daten einer Datenbank werden in der Antwort angezeigt.
404 Eine „Datenbank nicht gefunden“-Meldung wird in der Antwort angezeigt.
Beispielanfrage
Eine schreibgeschützte Abfrage mit GET ausführen
GET
https://api.ninox.com/v1/teams/{teamid}/databases/{dbid}/{query}
Führt eine schreibgeschützte Abfrage in einer Datenbank aus.
Pfadparameter
Name | Typ | Beschreibung |
---|---|---|
teamid* | string | Arbeitsbereich-ID |
dbid* | string | Datenbank-ID |
Abfrageparameter
Name | Typ | Beschreibung |
---|---|---|
query* | string | Zeichenkette einer Abfrage | z. B. (select Contact).'First Name' |
Header
Name | Typ | Beschreibung |
---|---|---|
Authorization* | string | Bearer {accessToken} |
Content-Type | string | application/json |
200 Die Vornamen der Datensätze in einer angegebenen Tabelle werden in der Antwort angezeigt.
Beispielanfrage
Eine schreibgeschützte Abfrage mit POST ausführen
POST
https://api.ninox.com/v1/teams/{teamid}/databases/{dbid}/{query}
Führt eine schreibgeschützte Abfrage in einer Datenbank aus.
Pfadparameter
Name | Typ | Beschreibung |
---|---|---|
teamid* | string | Arbeitsbereich-ID |
dbid* | string | Datenbank-ID |
Header
Name | Typ | Beschreibung |
---|---|---|
Authorization* | string | Bearer {accessToken} |
Content-Type | string | application/json |
Anfragetext
Name | Typ | Beschreibung |
---|---|---|
query* | string | Zeichenkette einer Abfrage | z. B. (select Contact).'First Name' |
200 Die Vornamen der Datensätze in einer angegebenen Tabelle werden in der Antwort angezeigt.
Beispielanfrage
Ausführen einer beschreibbaren Abfrage
POST
https://api.ninox.com/v1/teams/{teamid}/databases/{dbid}/exec
Führt eine schreibbare Abfrage in einer Datenbank aus.
Pfadparameter
Name | Typ | Beschreibung |
---|---|---|
teamid* | string | Arbeitsbereich-ID |
dbid* | string | Datenbank-ID |
Header
Name | Typ | Beschreibung |
---|---|---|
Authorization* | string | Bearer {accessToken} |
Content-Type | string | application/json |
Anfragetext
Name | Typ | Beschreibung |
---|---|---|
query* | string | Zeichenkette einer Abfrage | z. B. users() |
200 Eine Liste von Benutzern wird in der Antwort angezeigt.
Beispielanfrage
Ein Schema für mehrere Tabellen abrufen
GET
https://api.ninox.com/v1/teams/{teamid}/databases/{dbid}/tables
Ruft die Daten eines Schemas für mehrere Tabellen ab.
Pfadparameter
Name | Typ | Beschreibung |
---|---|---|
teamid* | string | Arbeitsbereich-ID |
dbid* | string | Datenbank-ID |
Header
Name | Typ | Beschreibung |
---|---|---|
Authorization* | string | Bearer {accessToken} |
Content-Type | string | application/json |
200 Die Daten eines Schemas für Tabellen werden in der Antwort angezeigt.
Beispielanfrage
Ein Schema für eine einzelne Tabelle abrufen
GET
https://api.ninox.com/v1/teams/{teamid}/databases/{dbid}/tables/{tid}
Ruft die Daten eines Schemas für eine einzelne Tabelle ab.
Pfadparameter
Name | Typ | Beschreibung |
---|---|---|
teamid* | string | Arbeitsbereich-ID |
dbid* | string | Datenbank-ID |
Header
Name | Typ | Beschreibung |
---|---|---|
Authorization* | string | Bearer {accessToken} |
Content-Type | string | application/json |
200 Die Daten eines Schemas für eine Tabelle werden in der Antwort angezeigt.
Beispielanfrage
Mehrere Datensätze abrufen
GET
https://api.ninox.com/v1/teams/{teamid}/databases/{dbid}/tables/{tid}/records
Ruft Daten aus mehreren Datensätzen in einer Tabelle ab.
Pfadparameter
Name | Typ | Beschreibung |
---|---|---|
teamid* | string | Arbeitsbereich-ID |
dbid* | string | Datenbank-ID |
tid* | string | Tabellen-ID |
Abfrageparameter
Name | Typ | Beschreibung |
---|---|---|
choiceStyle | string | ids | names |
choice | string | ids | names |
Header
Name | Typ | Beschreibung |
---|---|---|
Authorization* | string | Bearer {accessToken} |
Content-Type | string | application/json |
200 Die Daten aus den Datensätzen werden in der Antwort angezeigt.
Beispielanfrage
Einen einzelnen Datensatz abrufen
GET
https://api.ninox.com/v1/teams/{teamid}/databases/{dbid}/tables/{tid}/records/{rid}
Ruft Daten aus einem einzelnen Datensatz in einer Tabelle ab.
Pfadparameter
Name | Typ | Beschreibung |
---|---|---|
teamid* | string | Arbeitsbereich-ID |
dbid* | string | Datenbank-ID |
tid* | string | Tabellen-ID |
rid* | string | Datensatz-ID |
Abfrageparameter
Name | Typ | Beschreibung |
---|---|---|
choiceStyle | string | ids | names |
style | string | ids | names |
Header
Name | Typ | Beschreibung |
---|---|---|
Authorization* | string | Bearer {accessToken} |
Content-Type | string | application/json |
200 Die Daten eines Datensatzes werden in der Antwort angezeigt.
Beispielanfrage
Einen einzelnen Datensatz mit PUT aktualisieren
PUT
https://api.ninox.com/v1/teams/{teamid}/databases/{dbid}/tables/{tid}/records/{rid}
Aktualisiert einen einzelnen Datensatz in einer Tabelle
Pfadparameter
Name | Typ | Beschreibung |
---|---|---|
teamid* | string | Arbeitsbereich-ID |
dbid* | string | Datenbank-ID |
tid* | string | Tabellen-ID |
rid* | string | Datensatz-ID |
Headers
Name | Typ | Beschreibung |
---|---|---|
Authorization* | string | Bearer {accessToken} |
Content-Type | string | application/json |
Anfragetext
Name | Typ | Beschreibung |
---|---|---|
fields | object | object of a field | e.g., "First name": "Jane" |
200 Aktualisierte Daten aus einem Datensatz werden in der Antwort angezeigt
Beispielanfrage
Nachschlagen/Suchen eines einzelnen Datensatzes mit GET
GET
https://api.ninox.com/v1/teams/{teamid}/databases/{dbid}/tables/{tid}/records
Nachschlagen/Suchen eines einzelnen Datensatzes in einer Tabelle
Pfadparameter
Name | Typ | Beschreibung |
---|---|---|
teamid* | string | Arbeitsbereich-ID |
dbid* | string | Datenbank-ID |
tid* | string | Tabellen-ID |
Abfrageparameter
Name | Typ | Beschreibung |
---|---|---|
filters | object | object of filters | e.g., "L": "Stanley" |
Headers
Name | Typ | Beschreibung |
---|---|---|
Authorization | string | Bearer {accessToken} |
Content-Type | string | application/json |
200: OK Die Daten eines Datensatzes werden in der Antwort angezeigt
Um einen Datensatz mit GET abzurufen, stellen Sie sicher, dass der Endpunkt/records lautet. Das Ergebnis ist dasselbe wie bei der Suche nach einem einzelnen Datensatz mit POST (siehe unten).
Um festzustellen, welche Filter welchen IDs zugeordnet sind, senden Sie eine GET-Anfrage, um das Schema einer einzelnen Tabelle abzurufen.
Beispielanfrage
Alternative Notation
Eine alternative Schreibweise der obigen Beispielanforderung besteht darin, die Parameterfilter in die URL aufzunehmen und D (Daten) leer zu lassen.
Einen einzelnen Datensatz nachschlagen/suchen mit POST
POST
https://api.ninox.com/v1/teams/{teamid}/databases/{dbid}/tables/{tid}/record
Sucht nach einem einzelnen Datensatz in einer Tabelle.
Pfadparameter
Name | Typ | Beschreibung |
---|---|---|
teamid* | string | Arbeitsbereich-ID |
dbid* | string | Datenbank-ID |
tid* | string | Tabellen-ID |
Abfrageparameter
Name | Typ | Beschreibung |
---|---|---|
style | string | ids | names |
dateStyle | string | ids | names |
choiceStyle | string | ids | names |
Header
Name | Typ | Beschreibung |
---|---|---|
Authorization* | string | Bearer {accessToken} |
Content-Type | string | application/json |
Anfragekörper
Name | Typ | Beschreibung |
---|---|---|
filters | Objekt | Objekt mit Filtern | z. B. "A": "A": "Sophie" |
200: Daten eines Datensatzes werden in der Antwort angezeigt
Der Endpunkt ist
/record
, nicht/records
.
Um herauszufinden, welche Filter welchen IDs zugeordnet sind, sende eine
GET
-Anfrage, um das Schema einer einzelnen Tabelle abzurufen.
Beispielanfrage
Alternative Notation
Eine alternative Notation für die obige Beispielanfrage besteht darin, den Parameter filters
in die URL einzufügen und D
(Daten) leer zu lassen.
Mehrere Datensätze erstellen/aktualisieren mit POST
POST
https://api.ninox.com/v1/teams/{teamid}/databases/{dbid}/tables/{tid}/records
Erstellt oder aktualisiert mehrere Datensätze in einer Tabelle.
Pfadparameter
Name | Typ | Beschreibung |
---|---|---|
teamid* | string | Arbeitsbereich-ID |
dbid* | string | Datenbank-ID |
tid* | string | Tabellen-ID |
Headers
Name | Typ | Beschreibung |
---|---|---|
Authorization* | string | Bearer {accessToken} |
Content-Type | string | application/json |
Anfragekörper
Name | Typ | Beschreibung |
---|---|---|
fields, rid | Array | Array von Feldern und Datensatz-IDs | z. B. |
200: Daten eines bestehenden und eines neu erstellten Datensatzes werden in der Antwort angezeigt
Beispielanfrage
Um einen bestehenden Datensatz zu aktualisieren, muss die Datensatz-ID angegeben werden sowie die zu aktualisierenden Felder.
Um einen neuen Datensatz zu erstellen, darf keine Datensatz-ID angegeben werden. Nur die zu speichernden Felder müssen angegeben werden.
Upsert (Aktualisieren/Einfügen) mehrerer Datensätze mit POST
POST
https://api.ninox.com/v1/teams/{tid}/databases/{dbid}/tables/{tid}/records
Updates vorhandene Datensätze oder insert neue Datensätze in eine Tabelle.
Pfadparameter
Name | Typ | Beschreibung |
---|---|---|
teamid* | string | Arbeitsbereich-ID |
dbid* | string | Datenbank-ID |
tid* | string | Tabellen-ID |
Headers
Name | Typ | Beschreibung |
---|---|---|
Authorization* | string | Bearer {accessToken} |
Content-Type | string | application/json |
Anfragekörper
Name | Typ | Beschreibung |
---|---|---|
_upsert | boolean | true | "_upsert": true |
fields, rid* | Array | Array von Feldern und Datensatz-IDs | z. B.:
|
200: OK – Daten eines bestehenden oder eines neu erstellten Datensatzes werden in der Antwort angezeigt
Beispielanfrage
Nutze die
upsert
-Datenbankoperation, wenn du einen einzelnen oder mehrere Datensätze mit derselben Datensatz-ID aktualisieren möchtest. Dies ist besonders nützlich, wenn mehrere Tabellen miteinander verknüpft sind.Zum Beispiel ermöglicht
upsert
die Synchronisierung von Änderungen zwischen mehreren Tabellen unter Beibehaltung der Datensatz-IDs:
Änderungen in einer Tabelle mit Sequenznummer abrufen aus einer Quelltabelle.
Wende diese Änderungen auf eine Ziel-Tabelle mit Upsert (aktualisieren/einfügen) mehrerer Datensätze mit POST an.
Änderungen in einer Datenbank mit Sequenznummer abrufen
GET
https://api.ninox.com/v1/teams/{teamid}/databases/{dbid}/changes?sinceSq={sequence}
Ruft Änderungen in einer Datenbank ab, beginnend mit einer angegebenen Sequenznummer.
Pfadparameter
Pfadparameter
Name | Typ | Beschreibung |
---|---|---|
teamid* | string | Arbeitsbereich-ID |
dbid* | string | Datenbank-ID |
Abfrageparameter
Name | Typ | Beschreibung |
---|---|---|
sinceSq={sequence}* | integer | Änderungen seit Sequenznummer | z. B., sinceSq=1 |
Header
Name | Typ | Beschreibung |
---|---|---|
Authorization* | string | Bearer {accessToken} |
Content-Type | string | application/json |
200: OK – Aktualisierungen aller Datensätze in allen Tabellen einer Datenbank werden in der Antwort angezeigt
Beispielanfrage
Änderungen in einer Tabelle mit Sequenznummer abrufen
GET
https://api.ninox.com/v1/teams/{teamid}/databases/{dbid}/tables/{tid}/changes?sinceSq={sequence}
Ruft Änderungen in einer Tabelle ab, beginnend mit einer angegebenen Sequenznummer
Pfadparameter
Name | Typ | Beschreibung |
---|---|---|
teamid* | string | Arbeitsbereich-ID |
dbid* | string | Datenbank-ID |
tid* | string | Tabellen-ID |
Abfrageparameter
Name | Typ | Beschreibung |
---|---|---|
sinceSq={sequence}* | integer | Änderungen seit Sequenznummer | z. B., sinceSq=1 |
Headers
Name | Typ | Beschreibung |
---|---|---|
Authorization* | string | Bearer {accessToken} |
Content-Type | string | application/json |
200: OK – Aktualisierungen aller Datensätze in einer Tabelle werden in der Antwort angezeigt
Beispielanfrage
Änderungen eines einzelnen Datensatzes mit Sequenznummer abrufen
GET
api.ninox.com/v1/teams/{teamid}/databases/{dbid}/tables/{tid}/records/{rid}/changes?sinceSq={sequence}
Ruft Änderungen eines einzelnen Datensatzes ab, beginnend mit einer angegebenen Sequenznummer
Pfadparameter
Name | Typ | Beschreibung |
---|---|---|
teamid* | string | Arbeitsbereich-ID |
dbid* | string | Datenbank-ID |
tid* | string | Tabellen-ID |
rid* | string | Datensatz-ID |
Abfrageparameter
Name | Typ | Beschreibung |
---|---|---|
sinceSq={sequence}* | integer | Änderungen seit Sequenznummer | z. B., sinceSq=1 |
Headers
Name | Typ | Beschreibung |
---|---|---|
Authorization* | string | Bearer {accessToken} |
Content-Type | string | application/json |
200: OK – Aktualisierungen eines einzelnen Datensatzes in einer Tabelle werden in der Antwort angezeigt
Beispielanfrage
Einen einzelnen Datensatz löschen
DELETE
https://api.ninox.com/v1/teams/{teamid}/databases/{dbid}/tables/{tid}/records/{rid}
Löscht einen einzelnen Datensatz aus einer Tabelle
Pfadparameter
Name | Typ | Beschreibung |
---|---|---|
teamid* | string | Arbeitsbereich-ID |
dbid* | string | Datenbank-ID |
tid* | string | Tabellen-ID |
rid* | string | Datensatz-ID |
Headers
Name | Typ | Beschreibung |
---|---|---|
Authorization* | string | Bearer {accessToken} |
Content-Type | string | application/json |
200 Ein leeres Objekt wird in der Antwort angezeigt
404 Eine „Nicht gefunden“-Nachricht wird in der Antwort angezeigt
Beispielanfrage
Mehrere Datensätze löschen
DELETE
https://api.ninox.com/v1/teams/{teamid}/databases/{dbid}/tables/{tid}/records
Löscht mehrere Datensätze aus einer Tabelle
Pfadparameter
Name | Typ | Beschreibung |
---|---|---|
teamid* | string | Arbeitsbereich-ID |
dbid* | string | Datenbank-ID |
tid* | string | Tabellen-ID |
Headers
Name | Typ | Beschreibung |
---|---|---|
Authorization* | string | Bearer {accessToken} |
Content-Type | string | application/json |
Anfragekörper
Name | Typ | Beschreibung |
---|---|---|
Datensatz-IDs* | Array | Array von Datensatz-IDs |
204 Die Antwort ist leer
Beispielanfrage
Eine einzelne Datei abrufen
GET
https://api.ninox.com/v1/teams/{teamid}/databases/{dbid}/tables/{tid}/records/{rid}/files/{file}
Ruft eine einzelne Datei aus einem Datensatz ab
Pfadparameter
Name | Typ | Beschreibung |
---|---|---|
teamid | string | Arbeitsbereich-ID |
dbid | string | Datenbank-ID |
tid | string | Tabellen-ID |
rid | string | Datensatz-ID |
file | string | Dateiname |
Headers
Name | Typ | Beschreibung |
---|---|---|
Authorization | string | Bearer {accessToken} |
Content-Type | string | application/json |
200 Eine Datei aus einem Datensatz wird in der Antwort angezeigt
Beispielanfrage
Hochladen einer einzelnen Datei mit POST
POST
https://api.ninox.com/v1/teams/{teamid}/databases/{dbid}/tables/{tid}/records/{rid}/files
Lädt eine einzelne Datei in einen Datensatz hoch
Pfadparameter
Name | Typ | Beschreibung |
---|---|---|
teamid | string | Arbeitsbereich-ID |
dbid | string | Datenbank-ID |
tid | string | Tabellen-ID |
rid | string | Datensatz-ID |
Headers
Name | Typ | Beschreibung |
---|---|---|
Authorization | string | Bearer {accessToken} |
Content-Type | string | multipart/form-data |
Antragstext
Name | Typ | Beschreibung |
---|---|---|
file* | object | object of a file as multipart/form-data |
202 In der Antwort wird die Meldung „File Uploaded Successfully“ angezeigt
Beispielanfrage
Löschen einer einzelnen Datei
DELETE
https://api.ninox.com/v1/teams/{teamid}/databases/{dbid}/tables/{tid}/records/{rid}/files/{file}
Löscht eine einzelne Datei in einem Datensatz aus einem Datensatz
Pfadparameter
Name | Typ | Beschreibung |
---|---|---|
teamid | string | Arbeitsbereich-ID |
dbid | string | Datenbank-ID |
tid | string | Tabellen-ID |
rid | string | Datensatz-ID |
file | string | Dateiname |
Headers
Name | Typ | Beschreibung |
---|---|---|
Authorization | string | Bearer {accessToken} |
Content-Type | string | application/json |
204 Die Antwort ist leer
Beispielanfrage
Metadaten für mehrere Dateien abrufen
GET
https://api.ninox.com/v1/teams/{teamid}/databases/{dbid}/tables/{tid}/records/{rid}/files
Abrufen von Metadaten für mehrere Dateien aus einem Datensatz
Pfadparameter
Name | Typ | Beschreibung |
---|---|---|
teamid | string | Arbeitsbereich-ID |
dbid | string | Datenbank-ID |
tid | string | Tabellen-ID |
rid | string | Datensatz-ID |
Headers
Name | Typ | Beschreibung |
---|---|---|
Authorization | string | Bearer {accessToken} |
Content-Type | string | application/json |
200 Metadaten für Dateien werden in der Antwort angezeigt
Beispiel-Anfrage
Abrufen von Metadaten für eine einzelne Datei
GET
https://api.ninox.com/v1/teams/{teamid}/databases/{dbid}/tables/{tid}/records/{rid}/files/{file}/metadata
Ruft Metadaten für eine einzelne Datei aus einem Datensatz ab
Pfadparameter
Name | Typ | Beschreibung |
---|---|---|
teamid | string | Arbeitsbereich-ID |
dbid | string | Datenbank-ID |
tid | string | Tabellen-ID |
rid | string | Datensatz-ID |
file | string | Dateiname |
Headers
Name | Typ | Beschreibung |
---|---|---|
Authorization | string | Bearer {accessToken} |
Content-Type | string | application/json |
200 Metadaten für eine Datei werden in der Antwort angezeigt
Beispiel-Anfrage
Eine Miniaturansicht für eine einzelne Datei abrufen
GET
https://api.ninox.com/v1/teams/{teamid}/databases/{dbid}/tables/{tid}/records/{rid}/files/{file}/thumb.jpg
Ruft eine Miniaturansicht für eine einzelne Datei aus einem Datensatz ab
Pfadparameter
Name | Typ | Beschreibung |
---|---|---|
teamid | string | Arbeitsbereich-ID |
dbid | string | Datenbank-ID |
tid | string | Tabellen-ID |
rid | string | Datensatz-ID |
Headers
Name | Typ | Beschreibung |
---|---|---|
Authorization | string | Bearer {accessToken} |
Content-Type | string | application/json |