0

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

Alle verfügbaren Ninox Private Cloud API-Endpunkte

💡 Inhalt in geschweiften Klammern { } stellt einen Platzhalter dar. Sowohl die geschweiften Klammern als auch der Inhalt müssen ersetzt werden, damit die Anfrage funktioniert.

Eine Private Cloud-Domain könnte „mycloud.ninoxdb.com“ sein, während eine On-Premises-Domäne eine IP- und Portnummer oder eine benutzerdefinierte Domäne wie „ninox.myowncloud.com“ sein könnte. 

⚠️ Bei Zugriff auf Ninox-Daten ist ein Body notwendig

Verwendet man http() um auf Daten in Ninox zuzugreifen muss ein Body übergeben werden. Sofern keine Informationen im Body übergeben werden müssen bleibt er lediglich leer. Ein Beispiel hierfür wäre:

http("GET", "https://api.ninox.com/v1/[...]", {Authorization: "Bearer xxxx-xxxx-xxxx", content-type: "application/json"}, {})

Mehrere Arbeitsbereiche abrufen

GET https://{private-cloud}.ninoxdb.de/v1/teams

Ruft Daten von mehreren Teams ab

Header

Name Typ Beschreibung
Authorization* string Bearer {accessToken}
Content-Type string application/json

200 Die Arbeitsbereichs-IDs und Arbeitsbereichsnamen werden in der Antwort angezeigt

    {
        "id": "u14mwnoutm14yrcnf",
        "name": "Private Cloud Test Team"
    },
    {
        "id": "s7qijy0myyie9xitp",
        "name": "Private Cloud Test Team_1"
    }
]

Beispielanforderung

curl https://anastasiya.ninoxdb.de/v1/teams
-X GET
-H "Authorization": "Bearer e66e5190-14ad-11ec-aa6f-3502731d486c"
-H "Content-Type": "application/json"

Einen einzelnen Arbeitsbereich abrufen

GET https://{private-cloud}.ninoxdb.de/v1/teams/{teamid}

Ruft Daten von einem einzelnen Team ab

Pfadparameter

Name Typ Beschreibung
teamid* string Arbeitsbereichs-ID

Header

Name Typ Beschreibung
Authorization* string Bearer {accessToken}
Content-Type string application/json

200 Die Arbeitsbereichs-ID und der Arbeitsbereichsname werden in der Antwort angezeigt

{
    "id": "u14mwnoutm14yrcnf",
    "name": "Private Cloud Test Team"
}

Beispielanforderung

curl https://anastasiya.ninoxdb.de/v1/teams/u14mwnoutm14yrcnf
-X GET
-H "Authorization": "Bearer e66e5190-14ad-11ec-aa6f-3502731d486c"
-H "Content-Type": "application/json"

Mehrere Datenbanken abrufen

GET https://{private-cloud}.ninoxdb.de/v1/teams/{teamid}/databases

Ruft Daten von mehreren Datenbanken ab

Pfadparameter

Name Typ Beschreibung
teamid* string Arbeitsbereichs-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": "pnum1qq8tpao",
        "name": "Private Cloud Test Database"
    }
]

Beispielanforderung

curl https://anastasiya.ninoxdb.de/v1/teams/u14mwnoutm14yrcnf/databases
-X GET
-H "Authorization": "Bearer e66e5190-14ad-11ec-aa6f-3502731d486c"
-H "Content-Type": "application/json"

Ein Schema für eine einzelne Datenbank abrufen

GET https://{private-cloud}.ninoxdb.de/v1/teams/{teamid}/databases/{dbid}

Ruft Daten aus einem Schema für eine einzelne Datenbank ab

Pfadparameter

Name Typ Beschreibung
teamid* string Arbeitsbereichs-ID
dbid* string Datenbank-ID

Header

Name Typ Beschreibung
Authorization* string Bearer {accessToken}
Content-Type string application/json

200 Daten aus einem Schema für eine Datenbank werden in der Antwort angezeigt

{
    "settings": {
        "name": "Private Cloud Test Database",
        "icon": "database",
        "color": "#9da9ce",
        "bgType": "image",
        "backgroundClass": "background-file",
        "backgroundTimestamp": 1631793054608
    },
    "schema": {
        "seq": 58,
        "version": 10,
        "nextTypeId": 4,
        "types": {
        },
        "afterOpenBehavior": "restoreNavigation",
        "fileSync": "full"
    }
}

404 Eine "Datenbank nicht gefunden"-Meldung wird in der Antwort angezeigt

{"message":"Datenbank nicht gefunden"}

Beispielanfrage

curl https://anastasiya.ninoxdb.de/v1/teams/u14mwnoutm14yrcnf/databases/pnum1qq8tpao
-X GET
-H "Authorization": "Bearer e66e5190-14ad-11ec-aa6f-3502731d486c"
-H "Content-Type": "application/json"

Schema für mehrere Ansichten abrufen

GET https://{private-cloud}.ninoxdb.de/v1/teams/{teamid}/databases/{dbid}/views

Ruft Daten aus einem Schema für mehrere Ansichten in einer Datenbank ab

Pfadparameter

Name Typ Beschreibung
teamid* string Workspace-ID
dbid* string Datenbank-ID

Header

Name Typ Beschreibung
Authorization* string Bearer {accessToken}
Content-Type string application/json

200 Die Daten aus dem Schema für die Ansichten werden in der Antwort angezeigt

[
    {
        "id": "DXaXkMZ54PN7Qstd",
        "order": 10,
        "type": "A",
        "caption": "(alle)",
        "config": {
            "type": "A"
        },
        "seq": 2
    },
    {
        "id": "k3G0efinn6PL2vjJ",
        "order": 10,
        "type": "C",
        "caption": "(alle)",
        "config": {
            "type": "C"
        },
        "seq": 56
    },
    {
        "id": "yCuVS0Uw23MePfDN",
        "order": 10,
        "type": "B",
        "caption": "(alle)",
        "config": {
            "type": "B",
            "sort": 1,
            "descending": false,
            "cols": [
            ]
        },
        "seq": 43
    }
]

Beispielanfrage

curl https://anastasiya.ninoxdb.de/v1/teams/u14mwnoutm14yrcnf/databases/pnum1qq8tpao/views
-X GET
-H "Authorization": "Bearer e66e5190-14ad-11ec-aa6f-3502731d486c"
-H "Content-Type": "application/json"

Führe eine schreibgeschützte Abfrage mit GET aus

GET https://{private-cloud}.ninoxdb.de/v1/teams/{teamid}/databases/{dbid}/query

Führt eine schreibgeschützte Abfrage in einer Datenbank aus

Pfadparameter

Name Typ Beschreibung
teamid* string Workspace-ID
dbid* string Datenbank-ID

Abfrageparameter

Name Typ Beschreibung
query* string Abfragezeichenfolge | 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

[
    "Naeem",
    "Anna"
]

Beispielanfrage

curl https://anastasiya.ninoxdb.de/v1/teams/u14mwnoutm14yrcnf/databases/pnum1qq8tpao/query?query=(select Contact).'First Name'
-X GET
-H "Authorization": "Bearer e66e5190-14ad-11ec-aa6f-3502731d486c"
-H "Content-Type": "application/json"

Führe eine schreibgeschützte Abfrage mit POST aus

POST https://{private-cloud}.ninoxdb.de/v1/teams/{teamid}/databases/{dbid}/query

Führt eine schreibgeschützte Abfrage in einer Datenbank aus

Pfadparameter

Name Typ Beschreibung
teamid* string Arbeitsbereichs-ID
dbid* string Datenbank-ID

Header

Name Typ Beschreibung
Authorization* string Bearer {accessToken}
Content-Type string application/json

Anfragekörper

Name Typ Beschreibung
query* string Abfrage-String | z. B., (select Contact).'First Name'

200 Die Vornamen der Datensätze in einer angegebenen Tabelle werden in der Antwort angezeigt

[
    "Naeem",
    "Anna"
]

Beispielanfrage

curl https://anastasiya.ninoxdb.de/v1/teams/u14mwnoutm14yrcnf/databases/pnum1qq8tpao/query
-X POST
-H "Authorization": "Bearer e66e5190-14ad-11ec-aa6f-3502731d486c"
-H "Content-Type": "application/json"
-D '{
    "query": "(select Contact).'First Name'"
}'

Führe eine schreibbare Abfrage aus

POST https://{private-cloud}.ninoxdb.de/v1/teams/{teamid}/databases/{dbid}/exec

Führt eine schreibbare Abfrage in einer Datenbank aus

 

Pfadparameter

Name Typ Beschreibung
teamid* string Arbeitsbereichs-ID
dbid* string Datenbank-ID

Header

Name Typ Beschreibung
Authorization* string Bearer {accessToken}
Content-Type string application/json

Anfragekörper

Name Typ Beschreibung
query* string

Abfrage-String | z. B., users()

200 Der Benutzername wird in der Antwort angezeigt

[
    "root"
]

Beispielanfrage

curl https://anastasiya.ninoxdb.de/v1/teams/u14mwnoutm14yrcnf/databases/pnum1qq8tpao/exec
-X POST
-H "Authorization": "Bearer e66e5190-14ad-11ec-aa6f-3502731d486c"
-H "Content-Type": "application/json"
-D '{
    "query": "users()"
}'

Schema für mehrere Tabellen abrufen

GET https://{private-cloud}.ninoxdb.de/v1/teams/{teamid}/databases/{dbid}/tables

Ruft Daten aus einem Schema für mehrere Tabellen ab

Pfadparameter

Name Typ Beschreibung
teamid* string Arbeitsbereichs-ID
dbid* string Datenbank-ID

Header

Name Typ Beschreibung
Authorization* string Bearer {accessToken}
Content-Type string application/json

200 Daten aus einem Schema für Tabellen werden in der Antwort angezeigt

[
    {
        "id": "B",
        "name": "Contact",
        "fields": [
        ]
    },
    {
        "id": "D",
        "name": "Contact_1",
        "fields": [
        ]
    }
]

Beispielanforderung

curl https://anastasiya.ninoxdb.de/v1/teams/u14mwnoutm14yrcnf/databases/pnum1qq8tpao/tables
-X GET
-H "Authorization": "Bearer e66e5190-14ad-11ec-aa6f-3502731d486c"
-H "Content-Type": "application/json"

Schema für eine einzelne Tabelle abrufen

GET https://{private-cloud}.ninoxdb.de/v1/teams/{teamid}/databases/{dbid}/tables/{tid}

Ruft Daten aus einem Schema für eine einzelne Tabelle ab

Pfadparameter

Name Typ Beschreibung
teamid* string Arbeitsbereichs-ID
dbid* string Datenbank-ID
tid* string Tabellen-ID

Header

Name Typ Beschreibung
Authorization* string Bearer {accessToken}
Content-Type string application/json

200 Daten aus einem Schema für eine Tabelle werden in der Antwort angezeigt

{
    "id": "D",
    "name": "Contact_1",
    "fields": [
        {
            "id": "A",
            "name": "First name",
            "type": "string"
        }
    ]
}

Beispielanforderung

curl https://anastasiya.ninoxdb.de/v1/teams/u14mwnoutm14yrcnf/databases/pnum1qq8tpao/tables/D
-X GET
-H "Authorization": "Bearer e66e5190-14ad-11ec-aa6f-3502731d486c"
-H "Content-Type": "application/json"

Schema für mehrere Ansichten abrufen

GET https://{private-cloud}.ninoxdb.de/v1/teams/{teamid}/databases/{dbid}/tables/{tid}/views

Ruft Daten aus einem Schema für mehrere Ansichten einer Tabelle ab

Pfadparameter

Name Typ Beschreibung
teamid* string Arbeitsbereichs-ID
dbid* string Datenbank-ID
tid* string Tabellen-ID

Header

Name Typ Beschreibung
Authorization* string Bearer {accessToken}
Content-Type string application/json

200 Daten aus einem Schema für mehrere Ansichten werden in der Antwort angezeigt

[
    {
        "id": "yCuVS0Uw23MePfDN",
        "order": 10,
        "type": "B",
        "caption": "(alle)",
        "config": {
            "type": "B",
            "sort": 1,
            "descending": false,
            "cols": [
            ]
        },
        "seq": 43
    }
]

Beispielanforderung

curl https://anastasiya.ninoxdb.de/v1/teams/u14mwnoutm14yrcnf/databases/pnum1qq8tpao/tables/B/views
-X GET
-H "Authorization": "Bearer e66e5190-14ad-11ec-aa6f-3502731d486c"
-H "Content-Type": "application/json"

Geteilter Blick abrufen

GET https://{private-cloud}.ninoxdb.de/v1/teams/{teamid}/databases/{dbid}/tables/{tid}/views/{viewid}/share

Ruft einen geteilten Blick einer Tabelle ab

Pfadparameter

Name Typ Beschreibung
teamid* string Arbeitsbereichs-ID
dbid* string Datenbank-ID
tid* string Tabellen-ID
viewid* string Blick-ID

Header

Name Typ Beschreibung
Authorization* string Bearer {accessToken}
Content-Type string application/json

200 Eine URL des geteilten Blicks wird in der Antwort angezeigt

{
    "url": "https://anastasiya.ninoxdb.de/share/z571nojpwo86dhd6ycystohgl7oj72h0jb0v",
    "options": {
        }
    }
}

Beispielanforderung

curl https://anastasiya.ninoxdb.de/v1/teams/u14mwnoutm14yrcnf/databases/pnum1qq8tpao/tables/B/views/yCuVS0Uw23MePfDN/share
-X GET
-H "Authorization": "Bearer e66e5190-14ad-11ec-aa6f-3502731d486c"
-H "Content-Type": "application/json"

Erstellen/aktualisieren eines geteilten Blicks mit POST

POST https://{private-cloud}.ninoxdb.de/v1/teams/{teamid}/databases/{dbid}/tables/{tid}/views/{viewid}/share

Erstellt/aktualisiert einen geteilten Blick einer Tabelle

Pfadparameter

Name Typ Beschreibung
teamid* string Arbeitsbereichs-ID
dbid* string Datenbank-ID
tid* string Tabellen-ID
viewid* string Blick-ID

Header

Name Typ Beschreibung
Authorization* string Bearer {accessToken}
Content-Type string application/json

200 Eine aktualisierte oder neu erstellte URL eines geteilten Blicks wird in der Antwort angezeigt

{
    "url": "https://anastasiya.ninoxdb.de/share/z571nojpwo86dhd6ycystohgl7oj72h0jb0v",
    "options": {
        }
}

Beispielanforderung

curl https://anastasiya.ninoxdb.de/v1/teams/u14mwnoutm14yrcnf/databases/pnum1qq8tpao/tables/B/views/yCuVS0Uw23MePfDN/share
-X POST
-H "Authorization": "Bearer e66e5190-14ad-11ec-aa6f-3502731d486c"
-H "Content-Type": "application/json"

Gelöschten geteilten Blick entfernen

DELETE https://{private-cloud}.ninoxdb.de/v1/teams/{teamid}/databases/{dbid}/tables/{tid}/views/{viewid}/share

Löscht einen geteilten Blick einer Tabelle

Pfadparameter

Name Typ Beschreibung
teamid* string Arbeitsbereichs-ID
dbid* string Datenbank-ID
tid* string Tabellen-ID
viewid* string Blick-ID

Header

Name Typ Beschreibung
Authorization* string Bearer {accessToken}
Content-Type string application/json

204 Die Antwort ist leer

Hier ist die Übersetzung des Textes unter Beibehaltung der HTML-Formatierungen und Tabellen:

Beispielanforderung

curl https://anastasiya.ninoxdb.de/v1/teams/u14mwnoutm14yrcnf/databases/pnum1qq8tpao/tables/B/views/yCuVS0Uw23MePfDN/share
-X DELETE
-H "Authorization": "Bearer e66e5190-14ad-11ec-aa6f-3502731d486c"
-H "Content-Type": "application/json"

Mehrere Datensätze abrufen

GET https://{private-cloud}.ninoxdb.de/v1/teams/{teamid}/databases/{dbid}/tables/{tid}/records

Ruft Daten aus mehreren Datensätzen einer Tabelle ab

Pfadparameter

Name Typ Beschreibung
teamid* string Arbeitsbereichs-ID
dbid* string Datenbank-ID
tid* string Tabellen-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 Daten aus den Datensätzen werden in der Antwort angezeigt

[
    {
        "id": 5,
        "sequence": 47,
        "createdAt": "2021-09-13T18:24:26",
        "createdBy": "root",
        "modifiedAt": "2021-09-15T16:04:19",
        "modifiedBy": "a01n83X86",
        "fields": {
        }
    },
    {
        "id": 11,
        "sequence": 60,
        "createdAt": "2021-09-20T18:58:12",
        "createdBy": "a01n83X86",
        "modifiedAt": "2021-09-20T18:58:12",
        "modifiedBy": "a01n83X86",
        "fields": {
        }
    }
]

Beispielanforderung

curl https://anastasiya.ninoxdb.de/v1/teams/u14mwnoutm14yrcnf/databases/pnum1qq8tpao/tables/B/records
-X GET
-H "Authorization": "Bearer e66e5190-14ad-11ec-aa6f-3502731d486c"
-H "Content-Type": "application/json"

Einzelnen Datensatz abrufen

GET https://{private-cloud}.ninoxdb.de/v1/teams/{teamid}/databases/{dbid}/tables/{tid}/records/{rid}

Ruft Daten von einem einzelnen Datensatz in einer Tabelle ab

 

NEU 2Private

Pfadparameter

Name Typ Beschreibung
teamid* string Arbeitsbereichs-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 Daten aus einem Datensatz werden in der Antwort angezeigt

[
    {
        "id": 1,
        "sequence": 4,
        "createdAt": "2021-09-13T18:24:26",
        "createdBy": "root",
        "modifiedAt": "2021-09-13T18:24:26",
        "modifiedBy": "root",
        "fields": {
        }
    }
]

Beispielanforderung

curl https://anastasiya.ninoxdb.de/v1/teams/u14mwnoutm14yrcnf/databases/pnum1qq8tpao/tables/B/records/1
-X GET
-H "Authorization": "Bearer e66e5190-14ad-11ec-aa6f-3502731d486c"
-H "Content-Type": "application/json"

Einzelnen Datensatz mit PUT aktualisieren

PUT https://{private-cloud}.ninoxdb.de/v1/teams/{teamid}/databases/{dbid}/tables/{tid}/records/{rid}

Aktualisiert einen einzelnen Datensatz in einer Tabelle

Pfadparameter

Name Typ Beschreibung
teamid* string Arbeitsbereichs-ID
dbid* string Datenbank-ID
tid* string Tabellen-ID
rid* string Datensatz-ID

Header

Name Typ Beschreibung
Authorization* string Bearer {accessToken}
Content-Type string application/json

Anfragekörper

Name Typ Beschreibung
fields* object Objekt eines Feldes | z.B. "First name": "Jane"

200 Aktualisierte Daten aus einem Datensatz werden in der Antwort angezeigt

{
    "id": 1,
    "sequence": 79,
    "createdAt": "2021-09-21T14:32:42",
    "createdBy": "root",
    "modifiedAt": "2021-09-22T21:12:01",
    "modifiedBy": "a01n83X86",
    "fields": {
        "First name": "Jane"
    }
}

Beispiel-Anfrage

curl https://anastasiya.ninoxdb.de/v1/teams/u14mwnoutm14yrcnf/databases/pnum1qq8tpao/tables/D/records/1
-H "Authorization": "Bearer e66e5190-14ad-11ec-aa6f-3502731d486c"
-H "Content-Type": "application/json"
-D '{
    "fields": {
        "First name": "Jane"
    }
}'

Suche/Abfrage eines einzelnen Datensatzes mit GET

GET https://{private-cloud}.ninoxdb.de/v1/teams/{teamid}/databases/{dbid}/tables/{tid}/records

Sucht/Abfragt einen einzelnen Datensatz in einer Tabelle

Pfadparameter

Name Typ Beschreibung
teamid* string Arbeitsbereichs-ID
dbid* string Datenbank-ID
tid* string Tabellen-ID

Abfrageparameter

Name Typ Beschreibung
filters object Objekt mit Filtern | z.B., "L": "Jane"

Header

Name Typ Beschreibung
Authorization* string Bearer {accessToken}
Content-Type string application/json

200: OK Daten eines Datensatzes werden in der Antwort angezeigt

[
    {
        "_id": 21,
        "_sq": 164,
        "_cu": 0,
        "_cd": "",
        "_mu": "root",
        "_md": "2022-02-04T16:26:56",
        "A": "K0021",
        "B": 2,
        "D": "Garza",
        "K": "Julissa.Garza@torvus.com",
        "L": "Jane",
        "V": "Kundin Kopie.jpg",
        "W": [
            13,
            18
        ],
        "C1": 2,
        "D1": 3,
        "H1": 1,
        "I1": [
            3
        ]
    }
]

 ✅ Um zu erkennen, welche Filter auf welche IDs abgebildet sind, senden Sie eine GET-Anfrage, um das Schema einer einzelnen Tabelle abzurufen.

💡 Um einen Datensatz mit GET zu suchen, stellen Sie sicher, dass der Endpunkt /records lautet. Das Ergebnis wird dasselbe sein wie bei einer Suche/Abfrage eines einzelnen Datensatzes mit POST.

Beispiel-Anfrage

curl https://anastasiya.ninoxdb.de/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": "Jane"
    }
}'

Alternative Notation

Eine alternative Notation der oben genannten Beispiel-Anfrage besteht darin, den Parameter filters in der URL einzuschließen und D (Daten) leer zu lassen.

https://anastasiya.ninoxdb.de/v1/teams/u14mwnoutm14yrcnf/databases/w41fzot5t5wt/tables/A/records?filters={"L":"Jane"}

Suche/Abfrage eines einzelnen Datensatzes mit POST

POST https://{private-cloud}.ninoxdb.de/v1/teams/{teamid}/databases/{dbid}/tables/{tid}/record

Sucht/Abfragt einen einzelnen Datensatz in einer Tabelle

Pfadparameter

Name Typ Beschreibung
teamid* string Arbeitsbereichs-ID
dbid* string Datenbank-ID
tid* string Tabellen-ID

Abfrageparameter

Name Typ Beschreibung
style string ids | Namen
choiceStyle string ids | Namen
dateStyle string ids | Namen

Header

Name Typ Beschreibung
Authorization* string Bearer {accessToken}
Content-Type string application/json

Anfrage-Body

Name Typ Beschreibung
filters object Objekt der Filter | z.B., "L": "Jane"

200 Daten eines Datensatzes werden in der Antwort angezeigt

{
    "id": 1,
    "sequence": 79,
    "createdAt": "2021-09-21T14:32:42",
    "createdBy": "root",
    "modifiedAt": "2021-09-22T21:12:01",
    "modifiedBy": "a01n83X86",
    "fields": {
        "First name": "Jane",
        "Last name": "Morris",
        "Birthday": "1990-07-12",
        "Concatenate of City": "Leed",
        "Job title": "Declarant",
        "Organization": "DJFK Software",
        "Department": "Export",
        "First of Address": "jkgdkf@mail.com"
    }
}

✅ Um zu identifizieren, welche Filter mit welchen IDs verknüpft sind, senden Sie eine GET-Anfrage, um das Schema eines einzelnen Datensatzes abzurufen.

💡 Um einen Datensatz mit POST zu suchen, stellen Sie sicher, dass der Endpunkt /record lautet. Das Ergebnis wird dasselbe sein wie in Suche/Abfrage eines einzelnen Datensatzes mit GET.

Beispiel-Anfrage

curl https://anastasiya.ninoxdb.de/v1/teams/u14mwnoutm14yrcnf/databases/pnum1qq8tpao/tables/D/record
-X POST
-H "Authorization": "Bearer e66e5190-14ad-11ec-aa6f-3502731d486c"
-H "Content-Type": "application/json"
-D '{
    "filters": {
        "L": "Jane"
    }
}'

Alternative Notation

Eine alternative Notation der oben genannten Beispiel-Anfrage besteht darin, den Parameter filters in der URL einzuschließen und D (Daten) leer zu lassen.

https://anastasiya.ninoxdb.de/v1/teams/u14mwnoutm14yrcnf/databases/pnum1qq8tpao/tables/D/record?filters={"L":"Jane"}

Mehrere Datensätze mit POST erstellen/aktualisieren

POST https://{private-cloud}.ninoxdb.de/v1/teams/{teamid}/databases/{dbid}/tables/{tid}/records

Erstellt/aktualisiert mehrere Datensätze in einer Tabelle

Pfadparameter

Name Typ Beschreibung
teamid* string Arbeitsbereichs-ID
dbid* string Datenbank-ID
tid* string Tabellen-ID

Header

Name Typ Beschreibung
Authorization* string Bearer {accessToken}
Content-Type string application/json

Anfrage-Body

Name Typ Beschreibung
fields, rid array

Array von Feldern und Datensatz-IDs | z.B., "2"

"First name": "Dennis" "First name": "Jody"

200 Daten von einem bestehenden und von einem neu erstellten Datensatz werden in der Antwort angezeigt

[
    {
        "id": 2,
        "sequence": 62,
        "createdAt": "2021-09-21T14:32:42",
        "createdBy": "root",
        "modifiedAt": "2021-09-22T21:28:33",
        "modifiedBy": "a01n83X86",
        "fields": {
            "First name": "Dennis",
        }
    },
    {
        "id": 9,
        "createdAt": "2021-09-22T21:28:33",
        "createdBy": "a01n83X86",
        "modifiedAt": "2021-09-22T21:28:33",
        "modifiedBy": "a01n83X86",
        "fields": {
            "First name": "Naeem"
        }
    }
]

Beispiel-Anfrage

curl https://anastasiya.ninoxdb.de/v1/teams/u14mwnoutm14yrcnf/databases/pnum1qq8tpao/tables/D/records
-X POST
-H "Authorization": "Bearer e66e5190-14ad-11ec-aa6f-3502731d486c"
-H "Content-Type": "application/json"
-D '[{
    "id": 2,
    "fields": {
        "First name": "Dennis"
    }
},{
    "fields": {
        "First name": "Jody"
    }
}]'

✅ 

  • Um einen bestehenden Datensatz zu aktualisieren, geben Sie eine Datensatz-ID und die Felder an, die Sie in einem Datensatz aktualisieren möchten.

  • Um einen neuen Datensatz zu erstellen, geben Sie keine Datensatz-ID an, sondern nur die Felder, die Sie in einem Datensatz erstellen möchten.

Upsert (Update/Insert) mehrere Datensätze mit POST

POST https://{private-cloud}.ninoxdb.de/v1/teams/{teamid}/databases/{dbid}/tables/{tid}/records

Aktualisiert Datensätze, wenn sie existieren, oder fügt neue Datensätze in einer Tabelle hinzu

Pfadparameter

Name Typ Beschreibung
teamid* string Arbeitsbereichs-ID
dbid* string Datenbank-ID
tid* string Tabellen-ID

Header

Name Typ Beschreibung
Authorization* string Bearer {accessToken}
Content-Type string application/json

Anfrage-Body

Name Typ Beschreibung
_upsert boolean true | "_upsert"
fields, rid* array

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

"_id": 43,

"E": "Alfred",

"G": "Becker"

200: OK Daten von einem bestehenden oder neu erstellten Datensatz werden in der Antwort angezeigt

{
    "config": {},
    "nextRids": {
        "A": 3
    },
    "updates": {
        "A1": {
            "_id": "A1",
            "_cu": "clh3u4m7qjzzaiyjg",
            "_cd": 1695043902780,
            "_mu": "clh3u4m7qjzzaiyjg",
            "_md": 1695043902780
        },
        "A2": {
            "_id": "A2",
            "_cu": "clh3u4m7qjzzaiyjg",
            "_cd": 1695043904692,
            "_mu": "clh3u4m7qjzzaiyjg",
            "_md": 1695043904692
        }
    },
    "removes": [],
    "files": [],
    "views": {
        "x3A7FgN7yeYYDQaZ": {
            "id": "x3A7FgN7yeYYDQaZ",
            "order": 10,
            "type": "A",
            "caption": "(all)",
            "config": {
                "type": "A"
            },
            "seq": 2
        }
    },
    "reports": {},
    "seq": 4
}

Beispielanfrage

curl https://anastasiya.ninoxdb.de/v1/teams/c1w72a5wl28zzmpn9/databases/k6lj89vm8vsl/changes?sinceSq=1
-X GET
-H "Authorization": "Bearer 90472720-5244-11ee-966b-d50b6af8825c"
-H "Content-Type": "application/json"

Änderungen in einer Tabelle mit Sequenznummer abrufen

GET https://{private-cloud}.ninoxdb.de/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 Arbeitsbereichs-ID
dbid* string Datenbank-ID
tid* string Tabellen-ID

Abfrageparameter

Name Typ Beschreibung
sinceSq={sequence}* integer Änderungen seit der Sequenznummer | z.B., sinceSq=1

Header

Name Typ Beschreibung
Authorization* string Bearer {accessToken}
Content-Type string application/json

200: OK Updates aller Datensätze in einer Tabelle werden in der Antwort angezeigt

{
    "nextRid": 3,
    "updates": {
        "A1": {
            "_id": "A1",
            "_cu": "clh3u4m7qjzzaiyjg",
            "_cd": 1694768352272,
            "_mu": "clh3u4m7qjzzaiyjg",
            "_md": 1694768352272,
            "A": "1",
            "O": ""
        },
        "A2": {
            "_id": "A2",
            "_cu": "clh3u4m7qjzzaiyjg",
            "_cd": 1694768417713,
            "_mu": "clh3u4m7qjzzaiyjg",
            "_md": 1694768417713,
            "A": "1",
            "O": ""
        }
    },
    "removes": [],
    "files": [],
    "views": {},
    "reports": {},
    "seq": 7
}

Beispielanfrage

Name Typ Beschreibung
rid* array Array von Datensatz-IDs

204 Die Antwort ist leer

Beispielanfrage

curl https://anastasiya.ninoxdb.de/v1/teams/u14mwnoutm14yrcnf/databases/pnum1qq8tpao/tables/D/records
-X DELETE -H "Authorization": "Bearer e66e5190-14ad-11ec-aa6f-3502731d486c"
-H "Content-Type": "application/json" -D '[7,8]'

Einzelne Datei abrufen

GET https://{private-cloud}.ninoxdb.de/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 Workspace-ID
dbid* string Datenbank-ID
tid* string Tabellen-ID
rid* string Datensatz-ID
file* string Dateiname

Header

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://anastasiya.ninoxdb.de/v1/teams/u14mwnoutm14yrcnf/databases/pnum1qq8tpao/tables/B/records/5/files/iStock-184877012.jpeg
-X GET -H "Authorization": "Bearer e66e5190-14ad-11ec-aa6f-3502731d486c"
-H "Content-Type": "application/json"

Eine einzelne Datei mit POST hochladen

POST https://{private-cloud}.ninoxdb.de/v1/teams/{teamid}/databases/{dbid}/tables/{tid}/records/{rid}/files

Lädt eine einzelne Datei zu einem Datensatz hoch

Pfadparameter

Name Typ Beschreibung
teamid* string Workspace-ID
dbid* string Datenbank-ID
tid* string Tabellen-ID
rid* string Datensatz-ID

Header

 

Name Typ Beschreibung
Authorization* string Bearer {accessToken}
Content-Type string multipart/form-data

Anfragekörper

Name Typ Beschreibung
file* string String einer Datei als multipart/form-data

Beispielanfrage

curl https://anastasiya.ninoxdb.de/v1/teams/u14mwnoutm14yrcnf/databases/pnum1qq8tpao/tables/B/records/5/files
-X POST -H "Authorization": "Bearer e66e5190-14ad-11ec-aa6f-3502731d486c"
-H "Content-Type": "multipart/form-data"
-F 'file=@"/Users/anastasiya/Downloads/iStock-184877012.jpeg"'

Eine einzelne Datei löschen

DELETE https://{private-cloud}.ninoxdb.de/v1/teams/{teamid}/databases/{dbid}/tables/{tid}/records/{rid}/files/{file}

Löscht eine einzelne Datei in einem Datensatz

Pfadparameter

Name Typ Beschreibung
teamid* string Workspace-ID
dbid* string Datenbank-ID
tid* string Tabellen-ID
rid* string Datensatz-ID
file* string Dateiname

Header

Name Typ Beschreibung
Authorization* string Bearer {accessToken}
Content-Type string application/json

204 Die Antwort ist leer

Beispielanfrage

curl https://anastasiya.ninoxdb.de/v1/teams/u14mwnoutm14yrcnf/databases/pnum1qq8tpao/tables/B/records/5/files/iStock-184877012.jpeg
-X DELETE
-H "Authorization": "Bearer e66e5190-14ad-11ec-aa6f-3502731d486c"
-H "Content-Type": "application/json"

Metadaten für mehrere Dateien abrufen

GET https://{private-cloud}.ninoxdb.de/v1/teams/{teamid}/databases/{dbid}/tables/{tid}/records/{rid}/files

Ruft Metadaten für mehrere Dateien aus einem Datensatz ab

Pfadparameter

Name Typ Beschreibung
teamid* string Workspace-ID
dbid* string Datenbank-ID
tid* string Tabellen-ID
rid* string Datensatz-ID

Header

Name Typ Beschreibung
Authorization* string Bearer {accessToken}
Content-Type string multipart/form-data

200 Metadaten für Dateien werden in der Antwort angezeigt

[     {         "name": "iStock-184877012.jpeg",         "contentType": "image/jpeg",         "size": 9771508,         "modifiedDate": 1631615786262,         "modifiedUser": "root",         "seq": 21     },     {         "name": "mobile-phone.jpeg",         "contentType": "image/jpeg",         "size": 3392328,         "modifiedDate": 1631615768535,         "modifiedUser": "root",         "seq": 20     } ]

Beispielanfrage

curl https://anastasiya.ninoxdb.de/v1/teams/u14mwnoutm14yrcnf/databases/pnum1qq8tpao/tables/B/records/5/files
-X GET -H "Authorization": "Bearer e66e5190-14ad-11ec-aa6f-3502731d486c"
-H "Content-Type": "application/json"

Metadaten für eine einzelne Datei abrufen

GET https://{private-cloud}.ninoxdb.de/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 Workspace-ID
dbid* string Datenbank-ID
tid* string Tabellen-ID
rid* string Datensatz-ID
file* string Dateiname

Header

Name Typ Beschreibung
Authorization* string Bearer {accessToken}
Content-Type string application/json

200 Metadaten für eine Datei werden in der Antwort angezeigt

{     "name": "123.jpeg",
"contentType": "image/jpeg",
"size": 3392328,
"modifiedDate": 1631615768535,
"modifiedUser": "root",
"seq": 36 }

Beispielanfrage

curl https://anastasiya.ninoxdb.de/v1/teams/u14mwnoutm14yrcnf/databases/pnum1qq8tpao/tables/B/records/5/files/123.jpeg/metadata
-X GET -H "Authorization": "Bearer e66e5190-14ad-11ec-aa6f-3502731d486c"
-H "Content-Type": "application/json"

Ein Thumbnail für eine einzelne Datei abrufen

GET https://{private-cloud}.ninoxdb.de/v1/teams/{teamid}/databases/{dbid}/tables/{tid}/records/{rid}/files/{file}/thumb.jpg

Ruft ein Thumbnail für eine einzelne Datei aus einem Datensatz ab

Pfadparameter

Name Typ Beschreibung
teamid* string Workspace-ID
dbid* string Datenbank-ID
tid* string Tabellen-ID
rid* string Datensatz-ID
file* string Dateiname

Header

Name Typ Beschreibung
Authorization* string Bearer {accessToken}
Content-Type string application/json

200 Das Thumbnail einer Datei wird in der Antwort angezeigt

Beispielanfrage

curl https://anastasiya.ninoxdb.de/v1/teams/u14mwnoutm14yrcnf/databases/pnum1qq8tpao/tables/B/records/5/files/123jpeg/thumb.jpg
-X GET -H "Authorization": "Bearer e66e5190-14ad-11ec-aa6f-3502731d486c"
-H "Content-Type": "application/json"

Einen Freigabelink für eine einzelne Datei abrufen

GET https://{private-cloud}.ninoxdb.de/v1/teams/{teamid}/databases/{dbid}/tables/{tid}/records/{rid}/files/{file}/share

Ruft eine einzelne freigegebene Datei aus einem Datensatz ab

 

Pfadparameter

Name Typ Beschreibung
teamid* string Workspace-ID
dbid* string Datenbank-ID
tid* string Tabellen-ID
rid* string Datensatz-ID
file* string Dateiname

Header

Name Typ Beschreibung
Authorization* string Bearer {accessToken}
Content-Type string application/json

200 Die URL einer vorhandenen freigegebenen Datei wird in der Antwort angezeigt

https://anastasiya.ninoxdb.de/share/w5qcx0sa2c7rdbm3swr12yi93a9oi771db1h

Beispielanfrage

curl https://anastasiya.ninoxdb.de/v1/teams/u14mwnoutm14yrcnf/databases/pnum1qq8tpao/tables/B/records/5/files/iStock-184877012.jpeg/share
-X GET
-H "Authorization": "Bearer e66e5190-14ad-11ec-aa6f-3502731d486c"
-H "Content-Type": "application/json"

Erstellen/aktualisieren eines Freigabelinks für eine einzelne Datei mit POST

POST https://{private-cloud}.ninoxdb.de/v1/teams/{teamid}/databases/{dbid}/tables/{tid}/records/{rid}/files/{file}/share

Lädt eine einzelne freigegebene Datei in einen Datensatz hoch

Pfadparameter

Name Typ Beschreibung
teamid* string Workspace-ID
dbid* string Datenbank-ID
tid* string Tabellen-ID
rid* string Datensatz-ID
file* string Dateiname

Header

Name Typ Beschreibung
Authorization* string Bearer {accessToken}
Content-Type string application/json

200 Die URL der neu hochgeladenen freigegebenen Datei wird in der Antwort angezeigt

https://anastasiya.ninoxdb.de/share/y24l3gw7ljknc7jyiwqdeas4288antvwvlri

Beispielanfrage

curl https://anastasiya.ninoxdb.de/v1/teams/u14mwnoutm14yrcnf/databases/pnum1qq8tpao/tables/B/records/5/files/mobile-phone.jpeg/share
-X POST -H "Authorization": "Bearer e66e5190-14ad-11ec-aa6f-3502731d486c"
-H "Content-Type": "application/json"

Löschen eines Freigabelinks für eine einzelne Datei

DELETE https://{private-cloud}.ninoxdb.de/v1/teams/{teamid}/databases/{dbid}/tables{tid}/records/{rid}/files/{file}/share

Löscht eine einzelne freigegebene Datei in einem Datensatz

Pfadparameter

Name Typ Beschreibung
teamid* string Workspace-ID
dbid* string Datenbank-ID
tid* string Tabellen-ID
rid* string Datensatz-ID
file* string Dateiname

Header

Name Typ Beschreibung
Authorization* string Bearer {accessToken}
Content-Type string application/json

204 Die Antwort ist leer

Beispielanfrage

curl https://anastasiya.ninoxdb.de/v1/teams/u14mwnoutm14yrcnf/databases/pnum1qq8tpao/tables/B/records/5/files/iStock-184877012.jpeg/share
-X DELETE
-H "Authorization": "Bearer e66e5190-14ad-11ec-aa6f-3502731d486c"
-H "Content-Type": "application/json"

Antwort

null
Anmelden, um zu antworten