API-Endpunkte für Public Cloud

aktualisiert vor 2 Wochen

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.

[
    {
        "id": "mnPLY6DMsvq9wz4id",
        "name": "Public Cloud Test Team"
    },
    {
        "id": "Cf8fqfNeCaAvBrjkS",
        "name": "Public Cloud Test Team_1"
    }
]

Beispielanfrage

curl https://api.ninox.com/v1/teams
-X GET
-H "Authorization": "Bearer c0da1580-1a26-11ec-ba4d-f9d8817e4f95"
-H "Content-Type": "application/json"

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.

{
    "id": "mnPLY6DMsvq9wz4id",
    "name": "Mein Team 1"
}

Beispielanfrage

curl https://api.ninox.com/v1/teams/mnPLY6DMsvq9wz4id
-X GET
-H "Authorization": "Bearer c0da1580-1a26-11ec-ba4d-f9d8817e4f95"
-H "Content-Type": "application/json"

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.

[
    {
        "id": "gt5k36w957yt",
        "name": "Kontakte"
    }
]

Beispielanfrage

curl https://api.ninox.com/v1/teams/mnPLY6DMsvq9wz4id/databases
-X GET
-H "Authorization": "Bearer c0da1580-1a26-11ec-ba4d-f9d8817e4f95"
-H "Content-Type": "application/json"

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.

{
    "settings": {
        "name": "Kontakte",
        "icon": "i-db-icon-big i-db i-team",
        "color": "#6691FF",
        "backgroundClass": "background-file",
        "backgroundTimestamp": 1505809647759
    },
    "schema": {
        "seq": 223,
        "version": 7,
        "nextTypeId": 10,
        "types": {
        },
        "afterOpenBehavior": "restoreNavigation",
        "fileSync": "full"
    }
}

404 Eine „Datenbank nicht gefunden“-Meldung wird in der Antwort angezeigt.

{
    "message": "Datenbank nicht gefunden"
}

Beispielanfrage

curl https://api.ninox.com/v1/teams/mnPLY6DMsvq9wz4id/databases/gt5k36w957yt
-X GET
-H "Authorization": "Bearer c0da1580-1a26-11ec-ba4d-f9d8817e4f95"
-H "Content-Type": "application/json"

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.

[
    "Tim",
    "Chalie",
    "John",
    "Caroline",
    "Sophie",
    "Hans",
    "Alfred ",
    "Nadin"
]

Beispielanfrage

curl https://api.ninox.com/v1/teams/mnPLY6DMsvq9wz4id/databases/pt53j1tburs8/query?query=(select Contact).'First Name'
-X GET
-H "Authorization": "Bearer c0da1580-1a26-11ec-ba4d-f9d8817e4f95"
-H "Content-Type": "application/json"

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.

[
    "Tim",
    "Chalie",
    "John",
    "Caroline",
    "Sophie",
    "Hans",
    "Alfred ",
    "Nadin"
]

Beispielanfrage

curl https://api.ninox.com/v1/teams/mnPLY6DMsvq9wz4id/databases/gt5k36w957yt/query
-X POST
-H "Authorization": "Bearer c0da1580-1a26-11ec-ba4d-f9d8817e4f95"
-H "Content-Type": "application/json"
-D {
    "query": "(select Contact).'First Name'"
}

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.

[
    "anm2jMxL7kRuatXW9"
]

Beispielanfrage

curl https://api.ninox.com/v1/teams/mnPLY6DMsvq9wz4id/databases/gt5k36w957yt/exec
-X POST
-H "Authorization": "Bearer c0da1580-1a26-11ec-ba4d-f9d8817e4f95"
-H "Content-Type": "application/json"
-D '{
    "query": "users()"
}'

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.

[
    {
        "id": "A",
        "name": "Contact",
        "fields": [
        ]
    },
    {
        "id": "B",
        "name": "Contact Email",
        "fields": [
        ]
    },
    {
        "id": "C",
        "name": "Contact Phone",
        "fields": [
        ]
    },
    {
        "id": "D",
        "name": "Contact Address",
        "fields": [
        ]
    },
    {
        "id": "E",
        "name": "Contact Internet",
        "fields": [
        ]
    },
    {
        "id": "F",
        "name": "Contact instant messenger accounts",
        "fields": [
        ]
    },
    {
        "id": "G",
        "name": "Contact social profiles",
        "fields": [
        ]
    },
    {
        "id": "H",
        "name": "Table1",
        "fields": [
        ]
    },
    {
        "id": "I",
        "name": "Table2",
        "fields": [
        ]
    }
]

Beispielanfrage

curl https://api.ninox.com/v1/teams/mnPLY6DMsvq9wz4id/databases/gt5k36w957yt/tables
-X GET
-H "Authorization": "Bearer c0da1580-1a26-11ec-ba4d-f9d8817e4f95"
-H "Content-Type": "application/json"

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.

{
    "id": "A",
    "name": "Contact",
    "fields": [
        {
            "id": "A",
            "name": "Kind",
            "type": "choice",
            "choices": [
                {
                    "id": "1",
                    "caption": "Person",
                    "captions": {}
                },
                {
                    "id": "2",
                    "caption": "Company",
                    "captions": {}
                }
            ]
        }
    ]
}

Beispielanfrage

curl https://api.ninox.com/v1/teams/mnPLY6DMsvq9wz4id/databases/gt5k36w957yt/tables/A
-X GET
-H "Authorization": "Bearer c0da1580-1a26-11ec-ba4d-f9d8817e4f95"
-H "Content-Type": "application/json"

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.

[
    {
        "id": 1,
        "createdAt": "",
        "createdBy": 0,
        "modifiedAt": "2017-08-01T16:52:12",
        "modifiedBy": "EPZ2zSxuC7jt6WF2D",
        "fields": {
        }
    }
    {
        "id": 4,
        "createdAt": "",
        "createdBy": "EPZ2zSxuC7jt6WF2D",
        "modifiedAt": "2017-08-01T17:06:52",
        "modifiedBy": "EPZ2zSxuC7jt6WF2D",
        "fields": {
        }
    }
]

Beispielanfrage

curl https://api.ninox.com/v1/teams/Cf8fqfNeCaAvBrjkS/databases/zvdufqsrxwr2/tables/A/records
-X GET
-H "Authorization": "Bearer c0da1580-1a26-11ec-ba4d-f9d8817e4f95"
-H "Content-Type": "application/json"

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.

{
    "id": 1,
    "createdAt": "",
    "createdBy": 0,
    "modifiedAt": "2017-08-01T16:52:12",
    "modifiedBy": "EPZ2zSxuC7jt6WF2D",
    "fields": {}
}

Beispielanfrage

curl https://api.ninox.com/v1/teams/Cf8fqfNeCaAvBrjkS/databases/zvdufqsrxwr2/tables/A/records/1
-X GET
-H "Authorization": "Bearer c0da1580-1a26-11ec-ba4d-f9d8817e4f95"
-H "Content-Type": "application/json"

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

{
    "id": 8,
    "sequence": 207,
    "createdAt": "",
    "createdBy": "EPZ2zSxuC7jt6WF2D",
    "modifiedAt": "2021-09-23T14:47:09",
    "modifiedBy": "admin",
    "fields": {
        "First name": "Jane"
    }
}

Beispielanfrage

curl https://api.ninox.com/v1/teams/Cf8fqfNeCaAvBrjkS/databases/zvdufqsrxwr2/tables/A/records/8
-X PUT
-H "Authorization": "Bearer c0da1580-1a26-11ec-ba4d-f9d8817e4f95"
-H "Content-Type": "application/json"
-D '{
    "fields": {
        "First name": "Jane"
    }
}'

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

{
    "id": 1,
    "sequence": 133,
    "createdAt": "",
    "createdBy": 0,
    "modifiedAt": "2022-02-04T09:51:59",
    "modifiedBy": "root",
    "fields": {
        "Customer No": "K0001",
        "Title": "Mr",
        "Last Name": "Potts",
        "Email": "Stanley.Potts@cba.zyx",
        "First Name": "Stanley",
        "Image": "shutterstock_1519120589.jpg",
        "To Do": [
            23
        ],
        "Language": "DE",
        "Company": 1,
        "Status": "Active",
        "Meetings": [
            8,
            9
        ]
    }
}

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

curl https://api.ninox.com/v1/teams/u14mwnoutm14yrcnf/databases/w41fzot5t5wt/tables/A/records
-X GET
-H "Content-Type": "application/json"
-H "Authorization": "Bearer e66e5190-14ad-11ec-aa6f-3502731d486c"
-D '{
    "filters": {
        "L": "Stanley"
    }
}'

Alternative Notation

Eine alternative Schreibweise der obigen Beispielanforderung besteht darin, die Parameterfilter in die URL aufzunehmen und D (Daten) leer zu lassen.

https://api.ninox.com/v1/teams/u14mwnoutm14yrcnf/databases/w41fzot5t5wt/tables/A/records?filters={"L":"Stanley"}

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

{
    "id": 6,
    "sequence": 90,
    "createdAt": "2021-09-28T09:32:42",
    "createdBy": "anm2jMxL7kRuatXW9",
    "modifiedAt": "2021-09-28T09:35:07",
    "modifiedBy": "EPZ2zSxuC7jt6WF2D",
    "fields": {
        "Vorname": "Sophie",
        "Nachname": "Baxter",
        "Geburtsdatum": "1980-05-10",
        "Stadt": "London",
        "Berufsbezeichnung": "Leiterin der Logistik",
        "Unternehmen": "Hub City, Ltd.",
        "Abteilung": "Import",
        "E-Mail": "bax@hubcity.com"
    }
}

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

curl https://api.ninox.com/v1/teams/u14mwnoutm14yrcnf/databases/w41fzot5t5wt/tables/A/record
-X POST
-H "Content-Type": "application/json"
-H "Authorization": "Bearer e66e5190-14ad-11ec-aa6f-3502731d486c"
-D '{
    "filters": {
        "L": "Stanley"
    }
}'

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.

https://api.ninox.com/v1/teams/u14mwnoutm14yrcnf/databases/w41fzot5t5wt/tables/A/record?filters={"L":"Stanley"}

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. `"1"` `"Vorname": "Tom"` `"Vorname": "Andrea"`

200: Daten eines bestehenden und eines neu erstellten Datensatzes werden in der Antwort angezeigt

[
    {
        "id": 1,
        "createdAt": "",
        "createdBy": 0,
        "modifiedAt": "2021-09-23T17:05:42",
        "modifiedBy": "admin",
        "fields": {
            "Vorname": "Tom",
        }
    },
    {
        "id": 12,
        "createdAt": "2021-09-23T17:05:42",
        "createdBy": "admin",
        "modifiedAt": "2021-09-23T17:05:42",
        "modifiedBy": "admin",
        "fields": {
            "Vorname": "Andrea",
        }
    }
]

Beispielanfrage

curl https://api.ninox.com/v1/teams/Cf8fqfNeCaAvBrjkS/databases/zvdufqsrxwr2/tables/A/records
-X POST
-H "Authorization": "Bearer c0da1580-1a26-11ec-ba4d-f9d8817e4f95"
-H "Content-Type": "application/json"
-D [{
    "id": 1,
    "fields": {
        "Vorname": "Tom"
    }
},{
    "fields": {
        "Vorname": "Andrea"
    }
}]

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

Name	Typ	Beschreibung
_upsert	boolean	true \| `"_upsert": true`
fields, rid*	Array	Array von Feldern und Datensatz-IDs \| z. B.: `"_id": 43,` `"E": "Alfred",` `"G": "Becker"`

Array von Feldern und Datensatz-IDs | z. B.:

"_id": 43,

"E": "Alfred",

"G": "Becker"

200: OK – Daten eines bestehenden oder eines neu erstellten Datensatzes werden in der Antwort angezeigt

[
    {
        "_id": 43,
        "_cu": "admin",
        "_cd": "2023-09-19T13:07:40",
        "_mu": "admin",
        "_md": "2023-09-19T13:07:40",
        "A": "Person",
        "E": "Alfred",
        "G": "Becker",
        "O": ""
    },
    {
        "_id": 44,
        "_cu": "admin",
        "_cd": "2023-09-19T13:07:40",
        "_mu": "admin",
        "_md": "2023-09-19T13:07:40",
        "A": "Person",
        "E": "Caroline",
        "G": "Schultz",
        "O": ""
    },
    {
        "_id": 45,
        "_cu": "admin",
        "_cd": "2023-09-19T13:07:40",
        "_mu": "admin",
        "_md": "2023-09-19T13:07:40",
        "A": "Person",
        "E": "Hans",
        "G": "Copeland",
        "O": ""
    }
]

Beispielanfrage

curl https://api.ninox.com/v1/teams/XFND77BerC5NNoxK4/databases/vibpwezinpsx/tables/A/records
-X POST
-H "Authorization": "Bearer ff184e50-0699-11ee-86e5-e581bf9dd2fe"
-H "Content-Type": "application/json"
-D '[{
"_upsert": true,
"_id": 43,
"E": "Alfred",
"G": "Becker"
}, {
"_upsert": true,
"_id": 44,
"E": "Caroline",
"G": "Schultz"
}, {
"_upsert": true,
"_id": 45,
"E": "Hans",
"G": "Copeland"
}]'

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

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

{
    "config": {},
    "nextRids": {
        "A": 2
    },
    "updates": {
        "A1": {
            "_id": "A1",
            "_cu": "whQnZogNQm2XaWWgL",
            "_cd": 1695050930216,
            "_mu": "whQnZogNQm2XaWWgL",
            "_md": 1695050930216
        }
    },
    "removes": [],
    "files": [],
    "views": {
        "OLUnKwMQJaibWUzI": {
            "id": "OLUnKwMQJaibWUzI",
            "order": 10,
            "type": "A",
            "caption": "(alle)",
            "config": {
                "type": "A"
            },
            "seq": 2
        }
    },
    "reports": {},
    "seq": 3
}

Beispielanfrage

curl https://api.ninox.com/v1/teams/XFND77BerC5NNoxK4/databases/a2jufgz7xu1w/changes?sinceSq=1
-X GET
-H "Authorization": "Bearer fbf2d4a0-5628-11ee-bac8-87316d8c232f"
-H "Content-Type": "application/json"

Ä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

{
    "nextRid": 11,
    "updates": {},
    "removes": [
        "A8"
    ],
    "files": [],
    "views": {},
    "reports": {},
    "seq": 207
}

Beispielanfrage

curl https://api.ninox.com/v1/teams/XFND77BerC5NNoxK4/databases/vibpwezinpsx/tables/A/changes?sinceSq=1
-X GET
-H "Authorization": "Bearer fbf2d4a0-5628-11ee-bac8-87316d8c232f"
-H "Content-Type": "application/json"

Ä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

{
    "nextRid": 11,
    "updates": {
        "A1": {
            "_id": "A1",
            "_cu": 0,
            "_mu": "whQnZogNQm2XaWWgL",
            "_md": 1695051764090,
            "A": "1",
            "B": "1",
            "D": 315532800000,
            "E": "George",
            "G": "Hunter",
            "J": "Apricote AG",
            "K": "Marketing",
            "L": "Marketing Manager"
        }
    },
    "removes": [],
    "files": [],
    "seq": 214
}

Beispielanfrage

curl https://api.ninox.com/v1/teams/XFND77BerC5NNoxK4/databases/vibpwezinpsx/tables/A/records/1/changes?sinceSq=1
-X GET
-H "Authorization": "Bearer fbf2d4a0-5628-11ee-bac8-87316d8c232f"
-H "Content-Type": "application/json"

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

{"message":"Nicht gefunden"}

Beispielanfrage

curl https://api.ninox.com/v1/teams/mnPLY6DMsvq9wz4id/databases/gt5k36w957yt/tables/A/records/8
-X DELETE
-H "Authorization": "Bearer c0da1580-1a26-11ec-ba4d-f9d8817e4f95"
-H "Content-Type": "application/json"

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

curl https://api.ninox.com/v1/teams/mnPLY6DMsvq9wz4id/databases/gt5k36w957yt/tables/A/records
-X DELETE
-H "Authorization": "Bearer c0da1580-1a26-11ec-ba4d-f9d8817e4f95"
-H "Content-Type": "application/json"
-D '[23,24]'

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

curl https://api.ninox.com/v1/teams/mnPLY6DMsvq9wz4id/databases/gt5k36w957yt/tables/A/records/5/files/mobile-phone.jpeg
-X GET
-H "Authorization": "Bearer c0da1580-1a26-11ec-ba4d-f9d8817e4f95"
-H "Content-Type": "application/json"

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

Datei erfolgreich hochgeladen

Beispielanfrage

curl https://api.ninox.com/v1/teams/Cf8fqfNeCaAvBrjkS/databases/zvdufqsrxwr2/tables/A/records/4/files
-X POST
-H "Authorization": "Bearer c0da1580-1a26-11ec-ba4d-f9d8817e4f95"
-H "Content-Type": "multipart/form-data"
-F 'file=@"/Users/anastasiya/Downloads/iStock-184877012.jpeg"'

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

curl https://api.ninox.com/v1/teams/Cf8fqfNeCaAvBrjkS/databases/zvdufqsrxwr2/tables/A/records/10/files/iStock-184877012.jpeg
-X DELETE
-H "Authorization": "Bearer c0da1580-1a26-11ec-ba4d-f9d8817e4f95"
-H "Content-Type": "application/json"

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

[
    {
        "name": "ninox_logo.png",
        "contentType": "image/png",
        "size": 238483,
        "modifiedDate": 1632733575298,
        "modifiedUser": "anm2jMxL7kRuatXW9",
        "seq": 214
    },
    {
        "name": "shutterstock_562246966_resized.jpeg",
        "contentType": "image/jpeg",
        "size": 278467,
        "modifiedDate": 1632733761006,
        "modifiedUser": "anm2jMxL7kRuatXW9",
        "seq": 218
    }
]

Beispiel-Anfrage

curl https://api.ninox.com/v1/teams/Cf8fqfNeCaAvBrjkS/databases/zvdufqsrxwr2/tables/A/records/25/files
-X GET
-H "Authorization": "Bearer c0da1580-1a26-11ec-ba4d-f9d8817e4f95"
-H "Content-Type": "application/json"

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

{
    "name": "iStock-184877012.jpeg",
    "contentType": "image/jpeg",
    "size": 9771508,
    "modifiedDate": 1632407495923,
    "modifiedUser": "anm2jMxL7kRuatXW9",
    "seq": 253
}

Beispiel-Anfrage

curl https://api.ninox.com/v1/teams/mnPLY6DMsvq9wz4id/databases/gt5k36w957yt/tables/A/records/5/files/iStock-184877012.jpeg/metadata
-X GET
-H "Authorization": "Bearer c0da1580-1a26-11ec-ba4d-f9d8817e4f95"
-H "Content-Type": "application/json"

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

200 Die Miniaturansicht einer Datei wird in der Antwort angezeigt

Beispiel-Anfrage

curl https://api.ninox.com/v1/teams/mnPLY6DMsvq9wz4id/databases/gt5k36w957yt/tables/A/records/5/files/iStock-184877012.jpeg/thumb.jpg
-X GET
-H "Authorization": "Bearer c0da1580-1a26-11ec-ba4d-f9d8817e4f95"
-H "Content-Type": "application/json"

Verwandte Artikel

API-Endpunkte für Public Cloud

API-Endpunkte für Private Cloud/On-Premises

API-Calls im Ninox-Skript

Tabellen, Felder und Datensätze

Einführung in die Ninox API

Integrationen