Loading...

Aviso:

Para brindarle información de soporte completa de manera más rápida, el contenido de esta página ha sido traducido al español mediante traducción automática. Para consultar la información de soporte más precisa, consulte la versión en inglés de este contenido.

Actualizar elemento

Descripción

Esta API te permite actualizar un elemento de los datos existentes en una tabla NoSQL en tu proyecto. La tabla se referencia por su ID único o nombre.

Puedes pasar los atributos a actualizar con o sin especificar condiciones en el formato JSON personalizado.

Detalles de la solicitud

URL de solicitud

PUT

{api-domain}/baas/v1/project/{{project_id}}/nosqltable/{{table_identifier}}/item

copy

api-domain
URL
El dominio específico del DC para acceder a Catalyst API

project_id
Numerical
El ID único del proyecto

table_identifier
Numerical
El ID único de la tabla o nombre de la tabla

Encabezados de solicitud

Authorization: Zoho-oauthtoken {oauth_token}
Content-Type: application/json

Encabezados opcionales

CATALYST-ORG: {org_id}

Environment: Development

Scope

ZohoCatalyst.nosql.item.UPDATE

Nota: Esta operación también puede ejecutarse con permisos de autenticación de usuario de Catalyst usando los SDKs de Catalyst. Consulta la sección de Prerrequisitos de la API de Catalyst para más detalles.

Propiedades JSON de la solicitud

keys json
mandatory
Indica la partition key y la sort key de la tabla.
update_attributes json
mandatory

Indica el atributo a actualizar junto con su valor. La actualización puede ser de dos tipos: PUT (para agregar un nuevo atributo dentro del elemento) y DELETE (para eliminar un atributo del elemento). El attribute_path indica la ruta dentro del elemento donde se debe realizar la operación real. El valor a actualizar puede ser de dos tipos:

update_value json
mandatory
El valor real a actualizar.

update_function json
optional

Hay cuatro funciones que pueden usarse:
if_not_exists - Verifica la existencia del atributo y declara un valor si no está presente. append_list - Agrega datos a una lista add - Agrega un valor junto con el valor existente o agrega un elemento en un conjunto reduction - Resta un valor del valor existente o elimina un elemento en un conjunto.


condition json
optional

Los datos existentes de la tabla se obtienen y evalúan contra esta condición. Los elementos se insertan solo si la evaluación es verdadera. Si no hay datos existentes, las condiciones se ignoran y los elementos se insertan. Hay tres formas de inicializar una condición:

functions json
mandatory (if specifying condition)
Las dos funciones integradas son: attribute_exist, que puede usarse para verificar la presencia de un atributo, y attribute_type, que puede usarse para verificar si el nombre de atributo dado pertenece al tipo dado.

operator, attribute, value json
optional
Para realizar operaciones de comparación directa. Operadores soportados: contains, not_contains, begins_with, ends_with, in, not_in, between, not_between, equals, not_equals, greater_than, less_than, greater_equal, less_equal.

group, group operator json
optional
Para combinar dos o más condiciones. Operadores de grupo soportados: and, or.

negate json
optional
Para negar el resultado de las condiciones.

Detalles de la respuesta

La respuesta devolverá el estado de la operación de inserción, así como los detalles del elemento actualizado como el table_name, partition_key y sort_key, si están configurados.

Sample Request
copy

curl -X PUT
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/nosqltable/3376000003171728/item
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
-H “Content-Type:application/json”
-d ‘{ keys:{ partition_key:{ “S”:“Country” }, sort_key:{ “N”:“EmpID” }, } update_attributes:{ “item”: { “EmpID”: { “N”: “10999” }, “FirstName”:{ “S”: “Paul” }, “LastName”:{ “S”: “Smith” }, “PriorExperience”:{ “BOOL”: false }, “Location”: { “M”: { “Country”: { “S”: “USA” }, “City”: { “S”: “New York” } } } } } }’

Sample Response
copy
{
"status": "success",
"data": {
    "table_name": "employeeDetails",
    "project_details": {
        "id": 4000000006007,
        "project_name": "EmpDatabase",
        "project_type": "Live"
    }
}
}