Verificar estado de lectura masiva

Descripción

Puedes ejecutar esta API para verificar manualmente el estado del trabajo de lectura masiva que iniciaste previamente.

Si no configuraste una URL de callback en tu solicitud JSON, debes verificar el estado del trabajo tú mismo ejecutando esta API. Debes usar el job_id que se te envía en la respuesta automática de estado en progreso cuando inicias la operación de lectura masiva, para verificar el estado del trabajo posteriormente.

Detalles de la solicitud

URL de solicitud

GET

{api-domain}/baas/v1/project/{project_id}/bulk/read/{job_id}

copy

api-domain

URL

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

project_id

Numerical

El ID único del proyecto

job_id

Numerical

El ID único del trabajo que se envió en la respuesta inicial de estado en progreso después de ejecutar la API de lectura masiva

Encabezados de solicitud

Authorization: Zoho-oauthtoken {oauth_token}

Encabezados opcionales

CATALYST-ORG: {org_id}

Environment: Development

Scope

ZohoCatalyst.tables.bulk.READ

Detalles de la respuesta

La respuesta JSON para el estado exitoso contendrá los detalles del trabajo ejecutado, junto con una URL de descarga donde puedes descargar un archivo CSV que contendrá una lista de registros que coinciden con la consulta de tu trabajo de lectura masiva.

La respuesta JSON para el estado fallido contendrá los detalles del trabajo ejecutado, junto con una descripción del error que ocurrió en el procesamiento del trabajo y sus detalles, como las filas que se omitieron de la lectura y las razones.

Sample Request
copy

curl -X GET 

https://api.catalyst.zoho.com/baas/v1/project/4000000006007/bulk/read/2000000118004  

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

Sample Response: Job in Progress
copy

{
"status": "success",
"data": {
    "job_id": 2000000118004,
    "status": "In-Progress",
    "operation": "read",
    "project_details": {
        "project_name": "EmployeeDatabase",
        "id": 4000000006007
    },
    "query": [
        {
            "table_id": 3376000000165541,
            "details": {
                "page": "1"
            }
        }
    ],
    "callback": {
        "url": "https://hr.zylker.com/es/EmpRecords/_callback.php",
        "headers": {
                  "src" : "ZCatalyst",
                  "operation" : "bulkreadAPI"
                          },
        "params": {
                  "project_name" : "EmployeeDatabase"
                         }
    },
    "created_by": {
        "zuid": 1019540152,
        "is_confirmed": true,
        "email_id": "emma@zylker.com",
        "first_name": "Amelia",
        "last_name": "Burrows",
        "user_id": 671930409
    },
    "created_time": "Oct 06, 2020 07:06 PM"
}

}

Sample Response: Job Successful
copy

{
"status": "success",
"data": {
    "job_id": 2000000118004,
    "status": "Completed",
    "operation": "read",
    "project_details": {
        "project_name": "EmployeeDatabase",
        "id": 4000000006007
    },
    "query": [
                    {
            "table_id": 3376000000165541,
            "details": {
                "page": "1"
                            }
                      }
                   ],
    "callback": {
            "url": "https://hr.zylker.com/es/EmpRecords/_callback.php",
            "headers": {
                  "src" : "ZCatalyst",
                  "operation" : "bulkreadAPI"
                          },
              "params": {
                   "project_name" : "EmployeeDatabase"
                         }
                       },
    "created_by": {
            "zuid": 1019540152,
            "is_confirmed": true,
            "email_id": "emma@zylker.com",
            "first_name": "Amelia",
            "last_name": "Burrows",
            "user_id": 671930409
                           },
    "created_time": "Oct 06, 2020 07:06 PM",
"results": {
           "download_url": "https://api.catalyst.zoho.com/baas/v1/bulk/read/2000000117007/download",
           "description": "Bulk READ job 2000000117007 completed.",
            "details": [
                             {
                   "table_id": 3376000000165541,
                   "records_processed": 21,
                   "more_records": false
                             }
                           ]
                    }
           }

}

Sample Response: Job Failed
copy

{
"status": "success",
"data": {
    "job_id": 2000000117007,
    "status": "Failed",
    "operation": "read",
    "project_details": {
        "project_name": "EmployeeDatabase",
        "id": 4000000006007
    },
    "query": [
        {
            "table_id": 3376000000165541,
            "details": {
                "page": "1"
            }
        }
    ],
    "callback": {
        "url": "https://hr.zylker.com/es/EmpRecords/_callback.php",
         "headers": {
                  "src" : "ZCatalyst",
                  "operation" : "bulkreadAPI"
                          },
        "params": {
                   "project_name" : "EmployeeDatabase"
                         }
    },
    "created_by": {
        "zuid": 1019540152,
        "is_confirmed": true,
        "email_id": "emma@zylker.com",
        "first_name": "Amelia",
        "last_name": "Burrows",
        "user_id": 671930409
    },
    "created_time": "Oct 06, 2020 07:00 PM",
    "results": {
        "description": "The column ID in select_columns is invalid",
    }
}

}

Yes

Thank you for your feedback!

Send your feedback to us

Skip

Submit