Recuperar registros de la tabla de datos

Esta API permite enviar solicitudes para recuperar datos de registros paginados de una tabla de datos especificada.

Método de solicitud

POST

Endpoint

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

Autenticación

Para obtener más información, consúltese la descripción del método de autenticación en Visión general de la API.

Solicitud

Ejemplo de solicitud

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

Este bloque de código en una ventana flotante

Cabeceras de la solicitud

Campo	Tipo	Descripción
Authorization	Bearer ${API Key}	Se utiliza `Authorization: Bearer ${API Key}` para la autenticación. La clave de API se obtiene en la página «API Key».
Content-Type	application/json	Tipo de contenido; el valor es `application/json`.

Cuerpo de la solicitud

Campo	Tipo	Obligatorio	Descripción
table_id	string	Sí	ID de la tabla.
page	int	Sí	Número de página, a partir de 1.
page_size	int	Sí	Número de registros por página, intervalo 1-100.
filter	map	No	Condición de filtro definida por el usuario. Solo se admite un campo de filtrado, y ese campo debe tener `"unique": true`.
keyword	string	No	Palabra clave; permite búsqueda difusa.

Respuesta

Ejemplo de respuesta

{ "table_info": { "id": "673e9c7a9f7bc178002dbce8", "name": "test_api", "description": "Test all database 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 all database 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
        
}

Este bloque de código en una ventana flotante

Respuesta correcta

Campo	Tipo	Descripción
code	int	Código de tipo del mensaje.
message	string	Descripción del mensaje.
total_count	int	Número total de registros.
records	array	Lista de registros de datos.
records[].id	string	ID de los datos.
records[].value	object	Valores de los datos.
records[].created_at	long	Hora de creación.
records[].updated_at	long	Hora de actualización.
table_info	object	Información sobre la tabla de datos, incluidos los siguientes atributos:

Atributos de table_info

Campo	Tipo	Descripción
id	string	Identificador único de la tabla de datos.
name	string	Nombre de la tabla de datos.
description	string	Descripción de la tabla de datos.
field_count	int	Número de campos.
fields	array	Array de campos, incluida información detallada de cada campo.
fields[].name	string	Nombre del campo.
fields[].description	string	Descripción del campo.
fields[].type	string	Tipo de datos, como TEXT, INT, FLOAT, etc.
fields[].required	boolean	Indica si el campo es obligatorio.
fields[].unique	boolean	Indica si el campo es único.
bot_id	string	ID del bot.
project_id	string	ID del proyecto.
owner_id	string	ID del propietario de la tabla de datos.

Respuesta de error

Campo	Tipo	Descripción
code	int	Código de error.
message	string	Detalles del error.

Códigos de error

Código	Mensaje
40000	Parámetros no válidos
40127	Fallo en la autenticación del desarrollador
403106	No se encontró la tabla
403131	No tiene permiso para acceder a la tabla de datos
50000	Error interno del sistema