Actualizar datos de la tabla

Esta API permite actualizar por lotes los registros especificados en las tablas de base de datos del Agent, con un máximo de 100 registros por solicitud.

Nota:
El tamaño máximo del cuerpo de la solicitud JSON es de 5 MB.
Cada solicitud puede actualizar hasta 100 registros.

Método de solicitud

POST

URL de solicitud

https://api.${endpoint}gptbots.ai/v2/database/update/record

Autenticación

Para obtener detalles de autenticación, consulte Visión general de la API.

Solicitud

Ejemplo de solicitud

curl -X POST 'https://api-${endpoint}gptbots.ai/v2/database/update/record' \ -H 'Authorization: Bearer ${API Key}' \ -H 'Content-Type: application/json' \ -d '{ "table_id": "673af861ed69656ac0895b07", "is_create": true, "update_data":[ { "record_id":"123456", "updated_fields": { "name": "andy", "age": "30" } }, { "filter": { "id": "789" }, "updated_fields": { "name": "mop", "age": "32" } } ] }'

                      
                      curl -X POST 'https://api-${endpoint}gptbots.ai/v2/database/update/record' \
-H 'Authorization: Bearer ${API Key}' \
-H 'Content-Type: application/json' \
-d '{
      "table_id": "673af861ed69656ac0895b07",
      "is_create": true,
      "update_data":[
        {
          "record_id":"123456",
          "updated_fields": {
          "name": "andy",
          "age": "30"
          }
        },
        {
          "filter": {
            "id": "789"
          },
          "updated_fields": {
          "name": "mop",
          "age": "32"
          }
        }
      ]
    }'

Este bloque de código en una ventana flotante

Cabeceras de la solicitud

Campo	Tipo	Descripción
Authorization	Bearer ${API Key}	Autenticación mediante `Authorization: Bearer ${API Key}`. La clave de API se obtiene en la página «API Keys».
Content-Type	application/json	Formato de los datos; debe ser `application/json`.

Cuerpo de la solicitud

Campo	Tipo	Obligatorio	Descripción
table_id	string	Sí	ID de la tabla.
is_create	bool	No	Indica si se debe crear un nuevo registro cuando el registro de destino especificado no exista.
update_data	list	Sí	Colección de datos que se van a actualizar.
record_id	string	No	Se debe proporcionar `record_id` o `filter`. Se recomienda `record_id`.
filter	map	No	Condición de filtro definida por el usuario. Debe incluir un campo con `"unique": true`. Solo se admite un campo.
updated_fields	map	Sí	Colección de campos que se van a actualizar.

Nota

Se debe proporcionar record_id o filter. Si se envían ambos, record_id tiene prioridad.

El valor predeterminado de is_create es false.

Si no se proporciona is_create, no se creará ningún registro nuevo automáticamente.

Si is_create se establece en true, y el record_id o filter de un registro que se va a actualizar no existe en la tabla de datos, el registro se creará automáticamente.

Respuesta

Ejemplo de respuesta

{ "totalCount": 4, "success_count": 2, "fail_count": 2, "fail_detail": [ { "upsert_data": { "record_id": "123456", "value": { "name": "test user", "email": "invalid_email" } }, "fail_reason": "Invalid email format" }, { "upsert_data": { "filter": { "id": "789" }, "value": { "name": "test user", "email": "invalid_email" } }, "fail_reason": "Invalid email format" } ] }

                      
                      {
    "totalCount": 4,
    "success_count": 2,
    "fail_count": 2,
    "fail_detail": [
        {
            "upsert_data": {
                "record_id": "123456",
                "value": {
                    "name": "test user",
                    "email": "invalid_email"
                }
            },
            "fail_reason": "Invalid email format"
        },
        {
            "upsert_data": {
                "filter": {
                    "id": "789"
                },
                "value": {
                    "name": "test user",
                    "email": "invalid_email"
                }
            },
            "fail_reason": "Invalid email format"
        }
    ]
}

Este bloque de código en una ventana flotante

Respuesta correcta

Campo	Tipo	Descripción
totalCount	int	Número total de registros en esta operación de actualización
success_count	int	Número de registros actualizados correctamente
fail_count	int	Número de operaciones de actualización fallidas
fail_detail	array	Información detallada sobre actualizaciones fallidas
upsert_data	map	Datos de la solicitud para esta operación de actualización fallida
fail_reason	string	Motivo del fallo de la actualización

Respuesta de error

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

Códigos de error

Código	Mensaje
40000	Parámetros no válidos
50000	Error interno del sistema
403106	No se encontró la tabla
403131	No tiene permiso para acceder a la tabla