Obtener todas las filas de una tabla

Descripción

Esta API te permite obtener todas las filas de una tabla en particular de Data Store. Puedes hacer referencia a la tabla por su ID o nombre. La API incorpora paginación para obtener todas las filas. La paginación te permite recuperar los registros en páginas mediante una iteración de llamadas a la API.

Por ejemplo, si necesitas que las filas se obtengan en lotes de 100 como páginas individuales, debes incluir un parámetro max_rows en tu solicitud, que especifique el máximo de filas a obtener en cada página como 100.

Además, cada respuesta de la API contendrá un token que puedes pasar en la siguiente llamada a la API para obtener la siguiente página de filas. Este token autoriza la obtención subsiguiente de datos. Debes pasar la cadena de token obtenida en la respuesta de la llamada anterior a la API a través del parámetro next_token en la solicitud. No necesitas pasar el parámetro next_token en la primera llamada a la API. Puedes ejecutar una llamada a la API para cada iteración de esta manera y obtener todas las filas en páginas.

Detalles de la solicitud

URL de solicitud

GET

{api-domain}/baas/v1/project/{project_id}/table/{tableIdentifier}/row?next_token={token_string}&max_rows={number_of_rows}

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 el nombre de la tabla

next_token

Numerical

(no requerido para la primera llamada a la API) El valor del token obtenido de la llamada anterior a la API que se debe pasar para obtener el siguiente conjunto de filas mediante paginación

max_rows

Numerical

(opcional) El número máximo de filas que se deben devolver en una sola página mediante paginación. La API devolverá 200 filas en una sola página por defecto si no se especifica este valor.

Encabezados de solicitud

Authorization: Zoho-oauthtoken {oauth_token}

Encabezados opcionales

CATALYST-ORG: {org_id}

Environment: Development

Scope

ZohoCatalyst.tables.rows.READ

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

Detalles de la respuesta

La respuesta devolverá las filas obtenidas a través de la llamada a la API en páginas según el valor de max_rows que especifiques. Si hay más filas disponibles que la cantidad solicitada o el conteo de max_rows, la respuesta también contendrá el token que debes pasar para obtener el siguiente conjunto de filas como next_token. Si no hay más registros por obtener, la respuesta no contendrá un token.

Sample Request
copy

curl -X GET 

https://api.catalyst.zoho.com/baas/v1/project/4000000006007/table/CustomerDetails/row?max_rows=4&next_token=*************  

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

Sample Response (If more records available)
copy
{
    "status": "success",
    "data": [
    {
            "CREATORID": 56000000002003,
            "MODIFIEDTIME": "2019-03-06 10:16:41",
            "Department_ID": "IT148",
            "Department_Name": "Admin",
            "Employee_Name": "Eric Hyde",
            "CREATEDTIME": "2019-03-06 10:16:41",
            "ROWID": 56000000342025,
            "doubleDataType": null
        },
        {
            "CREATORID": 56000000002003,
            "MODIFIEDTIME": "2019-03-06 10:18:56",
            "Department_ID": "IT170",
            "Department_Name": "Sales",
            "Employee_Name": "Steven Kelso",
            "CREATEDTIME": "2019-03-06 10:18:56",
            "ROWID": 56000000342026,
            "doubleDataType": null
        },
    {
            "CREATORID": 56000000002003,
            "MODIFIEDTIME": "2019-03-06 10:19:00",
            "Department_ID": "IT190",
            "Department_Name": "Marketing",
            "Employee_Name": "Micheal Forman",
            "CREATEDTIME": "2019-03-06 10:18:58",
            "ROWID": 56000000342027,
            "doubleDataType": null
        },
    {
            "CREATORID": 56000000002003,
            "MODIFIEDTIME": "2019-03-06 10:45:11",
            "Department_ID": "IT111",
            "Department_Name": "Support",
            "Employee_Name": "Madeline Burkhart",
            "CREATEDTIME": "2019-03-06 10:18:34",
            "ROWID": 56000000342028,
            "doubleDataType": null
        },
    ],
"more_records" : true,
"next_token" : "{{token}}"
}

View more

Sample Response (If no more records available)
copy
{
    "status": "success",
    "data": [
    {
            "CREATORID": 56000000002003,
            "MODIFIEDTIME": "2019-03-06 10:16:41",
            "Department_ID": "IT148",
            "Department_Name": "Admin",
            "Employee_Name": "Eric Hyde",
            "CREATEDTIME": "2019-03-06 10:16:41",
            "ROWID": 56000000342025,
            "doubleDataType": null
        },
        {
            "CREATORID": 56000000002003,
            "MODIFIEDTIME": "2019-03-06 10:18:56",
            "Department_ID": "IT170",
            "Department_Name": "Sales",
            "Employee_Name": "Steven Kelso",
            "CREATEDTIME": "2019-03-06 10:18:56",
            "ROWID": 56000000342026,
            "doubleDataType": null
        },
    {
            "CREATORID": 56000000002003,
            "MODIFIEDTIME": "2019-03-06 10:19:00",
            "Department_ID": "IT190",
            "Department_Name": "Marketing",
            "Employee_Name": "Micheal Forman",
            "CREATEDTIME": "2019-03-06 10:18:58",
            "ROWID": 56000000342027,
            "doubleDataType": null
        },
    {
            "CREATORID": 56000000002003,
            "MODIFIEDTIME": "2019-03-06 10:45:11",
            "Department_ID": "IT111",
            "Department_Name": "Support",
            "Employee_Name": "Madeline Burkhart",
            "CREATEDTIME": "2019-03-06 10:18:34",
            "ROWID": 56000000342028,
            "doubleDataType": null
        },
    ],
"more_records" : false
}

View more

Get Rows- Java SDK

Get Rows- Node.js SDK

Get Rows- Python SDK

Get Rows- Web SDK

Yes

Thank you for your feedback!

Send your feedback to us

Skip

Submit