Obtener elemento

Descripción

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

Puedes especificar los atributos de los elementos a obtener, e incluso indicar si necesitan obtenerse del clúster maestro o de un clúster esclavo.

Detalles de la solicitud

URL de solicitud

GET

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

copy

api-domain

URL

El dominio específico del DC para acceder a Catalyst API

project_id

Numerical

El ID único del proyecto

tableIdentifier

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.READ

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.

required_attributes json

optional

Lista de atributos a devolver.

consistent_read json

optional

Declara si la lectura debe hacerse desde el maestro o el esclavo. Si se establece en false, se consulta desde el esclavo. Valores aceptados: true, false.

Detalles de la respuesta

La respuesta devolverá el estado de la operación de obtención, así como los elementos que se obtienen. Se obtendrán todos los atributos o los atributos especificados de los elementos.

Sample Request
copy

curl -X GET 

https://api.catalyst.zoho.com/baas/v1/project/4000000006007/nosqltable/3376000003171728/item/fetch 

-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57” 

-H “Content-Type:application/json” 

-d ‘{
keys:{
partition_key:{
“S”:“Country”
},
sort_key:{
“N”:“EmpID”
},
}
required_attributes: {
“EmpID”,
“FirstName”,
“LastName”,
“PriorExperience”
},
consistent_read: “true”
}’

Sample Response
copy

         {
"status": "success",
"data": {
    fetched_attributes:{
"item": {
"EmpID": {
"N": "10999"
},
"FirstName":{
"S": "Paul"
},
"LastName":{
"S": "Smith"
},
"PriorExperience":{
"BOOL": false
}
}
}
}
}


    

Fetch Items- Java SDK

Fetch Items- Node.js SDK

Fetch Items- Python SDK

Yes

Thank you for your feedback!

Send your feedback to us

Skip

Submit