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.

Search

Catalyst Search permite la búsqueda de datos en las columnas indexadas de las tablas en tu Catalyst Data Store. Cuando integras Search en tu aplicación, los usuarios finales podrán realizar búsquedas potentes a través de volúmenes de datos en tu Data Store con una sola consulta de búsqueda.

Ejecutar consulta de búsqueda

Descripción

Esta API te permite ejecutar una operación de búsqueda en las columnas indexadas de todas las tablas en el Data Store. Puedes pasar los parámetros de búsqueda en el JSON de la solicitud. Los registros que coinciden con la consulta de búsqueda se obtienen como respuesta.

Detalles de la solicitud

URL de solicitud

POST

{api-domain}/baas/v1/project/{project_id}/search

copy

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

project_id
Numerical
El ID único del proyecto

Encabezados de solicitud

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

Encabezados opcionales

CATALYST-ORG: {org_id}

Environment: Development

Scope

ZohoCatalyst.search.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

search string
mandatory

Patrón de búsqueda que contiene las palabras clave a buscar

Puedes proporcionar múltiples palabras clave separadas por comas.

search_table_columns json
mandatory

Las columnas indexadas a buscar en una tabla

Debes proporcionar esto en el siguiente formato:

{“table_name_1”: [“column_name_1”, “column_name_2”, “column_name_3”..], “table_name_2”: [“column_name_1”, “column_name_2”, “column_name_3”..]..}

select_table_columns json
optional

Las columnas a seleccionar y mostrar basándose en la búsqueda

Debes proporcionar esto en el siguiente formato:

{“table_name_1”: [“column_name_1”, “column_name_2”, “column_name_3”..], “table_name_2”: [“column_name_1”, “column_name_2”, “column_name_3”..]..}

order_by json
optional

Ordena los registros obtenidos en los resultados de búsqueda de manera ascendente o descendente

Valores permitidos: ASC, DESC

start integer
optional

Índice de inicio de una fila donde debe comenzar la búsqueda

Valor predeterminado: 0

end integer
optional

El valor de desplazamiento de una fila donde debe terminar la búsqueda

Valor predeterminado: 500

Detalles de la respuesta

La respuesta devuelve los registros que coinciden con la consulta de búsqueda. Se devuelven los detalles de las filas incluyendo sus metadatos como CREATORID y CREATEDTIME, y los nombres de clave de columna y valores.

Sample Request
copy

curl -X POST
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/search
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
-H “Content-Type: application/json”
-d ‘{ “search” : “Mary”, “search_table_columns” : { “CustomerInfo”: [ “CustomerName”, “TrainerName” ] }, “start”:1000, “end”:200 }’

Sample Response
copy
{
"status": "success",
"data": {
    "CustomerInfo": [
        {
            "CREATORID": "56000000002003",
            "MODIFIEDTIME": "2019-02-08 13:13:44",
            "CustomerName": "Mary Johnson",
            "TrainerName": "Helena Stewart",
            "CustomerID":"PL1213234",
            "CREATEDTIME": "2019-02-08 13:13:44"
        },
        {
            "CREATORID": "56000000002003",
            "MODIFIEDTIME": "2019-02-08 20:11:10",
            "CustomerName": "Mary Palmer",
            "TrainerName": "Ronald Wazlib",
            "CustomerID":"SY091834",
            "CREATEDTIME": "2019-02-08 20:11:10"
        },
       {
            "CREATORID": "56000000002003",
            "MODIFIEDTIME": "2019-11-09 10:00:12",
            "CustomerName": "Herbert Spielberg",
            "TrainerName": "Mary Amber Rogers",
            "CustomerID":"AL987627",
            "CREATEDTIME": "2019-11-08 00:12:40"
        }
    ]
}
}