Datenbank-Datensätze abrufen

Mit dieser API können Sie paginierte Datensätze aus einer bestimmten Datentabelle abrufen.

Anfragemethode

POST

Endpoint

https://api-${endpoint}.gptbots.ai/v1/database/records/page

Authentifizierung

Weitere Informationen zur Authentifizierung finden Sie in der Beschreibung zur API-Übersicht.

Anfrage

Beispielanfrage

curl -X POST 'https://api-${endpoint}.gptbots.ai/v1/database/records/page' \ -H 'Authorization: Bearer ${API Key}' \ -H 'Content-Type: application/json' \ -d '{ "table_id": "673d7d00ce119a7e9f47d152", "page": 1, "page_size": 10, "filter": { "int": 100 }, "keyword": "keyword" }'

                      
                      curl -X POST 'https://api-${endpoint}.gptbots.ai/v1/database/records/page' \
-H 'Authorization: Bearer ${API Key}' \
-H 'Content-Type: application/json' \
-d '{
    "table_id": "673d7d00ce119a7e9f47d152",
    "page": 1,
    "page_size": 10,
    "filter": { 
        "int": 100
    },
    "keyword": "keyword"
}'

Dieser Codeblock im schwebenden Fenster

Anfrage-Header

Feld	Typ	Beschreibung
Authorization	Bearer ${API Key}	Für die Authentifizierung verwenden Sie Authorization: Bearer ${API Key}. Den API-Schlüssel erhalten Sie auf der API-Key-Seite.
Content-Type	application/json	Datentyp, Wert ist application/json.

Anfrage-Body

Feld	Typ	Erforderlich	Beschreibung
table_id	string	Ja	Tabellen-ID.
page	int	Ja	Seitenzahl, beginnt bei 1.
page_size	int	Ja	Anzahl der Datensätze pro Seite, Bereich 1–100.
filter	map	Nein	Benutzerdefinierte Filterbedingung. Muss ein Feld mit `"unique": true` enthalten, es wird nur ein Feld unterstützt.
keyword	string	Nein	Stichwort, unterstützt unscharfe Suche.

Antwort

Beispielantwort

{ "table_info": { "id": "673e9c7a9f7bc178002dbce8", "name": "test_api", "description": "Test aller Datenbank-APIs", "field_count": 5, "fields": [ { "name": "id", "description": "id", "type": "TEXT", "required": true, "unique": true }, { "name": "boolean", "description": "boolean", "type": "BOOLEAN", "required": true, "unique": false }, { "name": "int", "description": "int", "type": "INT", "required": true, "unique": true }, { "name": "datetime", "description": "datetime", "type": "DATETIME", "required": true, "unique": false }, { "name": "float", "description": "float", "type": "FLOAT", "required": false, "unique": false } ], "bot_id": "673e93aca7c4223becf6caf0", "project_id": "665465e2b5c78e6c7ab92d2b", "owner_id": "665465e2b5c78e6c7ab92d28" }, "records": [ { "id": "541278230707963208", "value": { "id": "1", "boolean": true, "int": 1, "datetime": "2029-10-01 12:00:00", "float": 2024.21 }, "created_at": 1732156566000, "updated_at": 1732156607000 } ], "total_count": 2 }

                      
                      {
    "table_info": {
        "id": "673e9c7a9f7bc178002dbce8",
        "name": "test_api",
        "description": "Test aller Datenbank-APIs",
        "field_count": 5,
        "fields": [
            {
                "name": "id",
                "description": "id",
                "type": "TEXT",
                "required": true,
                "unique": true
            },
            {
                "name": "boolean",
                "description": "boolean",
                "type": "BOOLEAN",
                "required": true,
                "unique": false
            },
            {
                "name": "int",
                "description": "int",
                "type": "INT",
                "required": true,
                "unique": true
            },
            {
                "name": "datetime",
                "description": "datetime",
                "type": "DATETIME",
                "required": true,
                "unique": false
            },
            {
                "name": "float",
                "description": "float",
                "type": "FLOAT",
                "required": false,
                "unique": false
            }
        ],
        "bot_id": "673e93aca7c4223becf6caf0",
        "project_id": "665465e2b5c78e6c7ab92d2b",
        "owner_id": "665465e2b5c78e6c7ab92d28"
    },
    "records": [
        {
            "id": "541278230707963208",
            "value": {
                "id": "1",
                "boolean": true,
                "int": 1,
                "datetime": "2029-10-01 12:00:00",
                "float": 2024.21
            },
            "created_at": 1732156566000,
            "updated_at": 1732156607000
        }
    ],
    "total_count": 2
}

Dieser Codeblock im schwebenden Fenster

Erfolgreiche Antwort

Feld	Typ	Beschreibung
code	int	Code des Nachrichtentyps.
message	string	Nachrichtenbeschreibung.
total_count	int	Gesamtanzahl der Datensätze.
records	array	Array der Datensätze.
records[].id	string	Daten-ID.
records[].value	object	Datenwerte.
records[].created_at	long	Erstellungszeitpunkt.
records[].updated_at	long	Zeitpunkt der letzten Aktualisierung.
table_info	object	Informationen zur Datentabelle mit folgenden Attributen:

Attribute von table_info

Feld	Typ	Beschreibung
id	string	Eindeutige Kennung der Datentabelle.
name	string	Name der Datentabelle.
description	string	Beschreibung der Datentabelle.
field_count	int	Anzahl der Felder.
fields	array	Array der Felder mit Detailinformationen zu jedem Feld.
fields[].name	string	Feldname.
fields[].description	string	Feldbeschreibung.
fields[].type	string	Datentyp, z. B. TEXT, INT, FLOAT usw.
fields[].required	boolean	Ob das Feld erforderlich ist.
fields[].unique	boolean	Ob das Feld eindeutig ist.
bot_id	string	Agenten-ID.
project_id	string	Projekt-ID.
owner_id	string	Besitzer-ID der Datentabelle.

Fehlerantwort

Feld	Typ	Beschreibung
code	int	Fehlercode.
message	string	Fehlerdetails.

Fehlercodes

Code	Nachricht
40000	Ungültige Parameter
40127	Entwickler-Authentifizierung fehlgeschlagen
403106	Tabelle nicht gefunden
403131	Keine Berechtigung für den Zugriff auf die Datentabelle
50000	Interner Systemfehler