Consultar índice

Descripción

Esta API te permite consultar un índice NoSQL en tu proyecto y obtener datos. El índice se referencia por su ID único.

Detalles de la solicitud

URL de solicitud

POST

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

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

index_identifier

Numerical

El ID único del índice

Encabezados de solicitud

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

Encabezados opcionales

CATALYST-ORG: {org_id}

Environment: Development

Scope

ZohoCatalyst.nosql.POST

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

key_condition json

mandatory

Contiene la condición en un formato similar a las operaciones CRUD de elementos. Solo se pueden dar condiciones de partition key y sort key. La partition key solo puede tener el operador “equals”. La condición puede ser partition key = valor, o un grupo con condición de partition key equals y la condición de sort key. Consulta la lista completa de operadores soportados.

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.

other_condition json

optional

Estas son condiciones que se aplican sobre los datos obtenidos. La respuesta se envía después de que se aplican estas condiciones.

forwardScan json

optional

Se usa para indicar si la consulta debe hacerse en orden ascendente o descendente.

startKey json

optional

Se usa para fines de paginación para obtener el siguiente conjunto de elementos de datos.

additional_sort_key json

optional

Se usa para indicar si la consulta se hace contra la tabla con sort keys adicionales. Contiene los nombres de atributos de sort key adicionales.

limit json

optional

Indica la cantidad máxima de elementos que deben devolverse.

Detalles de la respuesta

La respuesta devolverá el estado de la operación de consulta, así como los elementos que se obtienen según las condiciones establecidas en la consulta.

Sample Request
copy

curl -X POST 

https://api.catalyst.zoho.com/baas/v1/project/4000000006007/nosqltable/3376000003171728/index/786387162881/item/query 

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

-H “Content-Type:application/json” 

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

Sample Response
copy

{
“status”: “success”,
“data”: {
fetched_data:{
“item”: {
“EmpID”: {
“N”: “10999”
},
“FirstName”:{
“S”: “Paul”
},
“LastName”:{
“S”: “Smith”
},
“PriorExperience”:{
“BOOL”: false
}
}
}
}
}

Query Index- Java SDK

Query Index- Node.js SDK

Query Index- Python SDK

Yes

Thank you for your feedback!

Send your feedback to us

Skip

Submit