Récupérer les enregistrements de la base de données

Cette API permet d'envoyer des requêtes pour récupérer les enregistrements paginés d'une table de données spécifiée.

Méthode de requête

POST

Endpoint

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

Authentification

Pour plus de détails, consultez la description de la méthode d'authentification dans la Présentation de l'API.

Requête

Exemple de requête

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"
}'

Ce bloc de code dans la fenêtre flottante

En-têtes de la requête

Champ	Type	Description
Authorization	Bearer ${API Key}	Utilisez Authorization: Bearer ${API Key} pour l'authentification. Obtenez la clé API depuis la page Clé API.
Content-Type	application/json	Type de données, la valeur est application/json.

Corps de la requête

Champ	Type	Obligatoire	Description
table_id	string	Oui	ID de la table.
page	int	Oui	Numéro de page, à partir de 1.
page_size	int	Oui	Nombre d'enregistrements par page, plage 1-100.
filter	map	Non	Condition de filtre définie par l'utilisateur. Doit inclure un champ avec `"unique": true`, et un seul champ est pris en charge.
keyword	string	Non	Mot-clé, prend en charge la recherche floue.

Réponse

Exemple de réponse

{ "table_info": { "id": "673e9c7a9f7bc178002dbce8", "name": "test_api", "description": "Test de toutes les API de base de données", "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 de toutes les API de base de données",
        "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
}

Ce bloc de code dans la fenêtre flottante

Réponse en cas de succès

Champ	Type	Description
code	int	Code du type de message.
message	string	Description du message.
total_count	int	Nombre total d'enregistrements.
records	array	Tableau des enregistrements de données.
records[].id	string	ID des données.
records[].value	object	Valeurs des données.
records[].created_at	long	Date de création.
records[].updated_at	long	Date de mise à jour.
table_info	object	Informations sur la table de données, incluant les attributs suivants :

Attributs de table_info

Champ	Type	Description
id	string	Identifiant unique de la table de données.
name	string	Nom de la table de données.
description	string	Description de la table de données.
field_count	int	Nombre de champs.
fields	array	Tableau des champs, incluant les informations détaillées de chaque champ.
fields[].name	string	Nom du champ.
fields[].description	string	Description du champ.
fields[].type	string	Type de données, tel que TEXT, INT, FLOAT, etc.
fields[].required	boolean	Si le champ est obligatoire.
fields[].unique	boolean	Si le champ est unique.
bot_id	string	ID de l'agent.
project_id	string	ID du projet.
owner_id	string	ID du propriétaire de la table de données.

Réponse en cas d'échec

Champ	Type	Description
code	int	Code d'erreur.
message	string	Détails de l'erreur.

Codes d'erreur

Code	Message
40000	Paramètres invalides
40127	Échec de l'authentification du développeur
403106	Table non trouvée
403131	Pas d'autorisation pour accéder à la table de données
50000	Erreur interne du système