Verificar estado de Bulk Write

Descripción

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

Si no habías configurado 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 envió en la respuesta automática de estado in-progress cuando iniciaste la operación de escritura masiva, para verificar el estado del trabajo posteriormente.

Detalles de la solicitud

URL de solicitud

GET

{api-domain}/baas/v1/project/{project_id}/bulk/write/{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 de estado in-progress](/es/api/introduction/overview-and-prerequisites/#response-details) inicial después de que se ejecutó la API Bulk Write

Encabezados de solicitud

Authorization: Zoho-oauthtoken {oauth_token}

Encabezados opcionales

CATALYST-ORG: {org_id}

Environment: Development

Scope

ZohoCatalyst.tables.bulk.CREATE

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 de informe CSV que contendrá los detalles de la ejecución del trabajo. Listará todos los registros que fueron omitidos de la escritura junto con las razones.

La respuesta JSON para el estado fallido contendrá los detalles del trabajo ejecutado, junto con una descripción del error ocurrido en el procesamiento del trabajo y sus detalles.

Sample Request
copy

curl -X GET 

https://api.catalyst.zoho.com/baas/v1/project/4000000006007/bulk/write/2000000110044  

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

Sample Response: Job in Progress
copy

{
    "status": "success",
    "data": {
        "job_id": 2000000110044,
        "status": "In-Progress",
        "operation": "insert",
        "project_details": {
            "project_name": "EmployeeDatabase",
            "id": 4000000006007
        }
        "query": [
            {
                "table_id": 3376000000165511,
                "details": {
                    "object_url" : "https://zylker-emp-development.zohostratus.com/employees/emp_rec.csv",
            }
        }
    ],
    &quot;callback&quot;: {
        &quot;url&quot;: &quot;https://hr.zylker.com/es/EmpRecords/_callback.php&quot;,
        &quot;headers&quot;: {
            &quot;src&quot;: &quot;ZCatalyst&quot;,
            &quot;operation&quot;: &quot;bulkwriteAPI&quot;
        },
        &quot;params&quot;: {
            &quot;project_name&quot;: &quot;EmployeeDatabase&quot;
        }
    },
    &quot;created_by&quot;: {
            &quot;zuid&quot;: 3000000006111,
            &quot;is_confirmed&quot;: true,
            &quot;email_id&quot;: &quot;emma@zylker.com&quot;,
            &quot;first_name&quot;: &quot;Amelia&quot;,
            &quot;last_name&quot;: &quot;Burrows&quot;,
            &quot;user_id&quot;: 671930409
    },
    &quot;created_time&quot;: &quot;Oct 05, 2020 07:33 PM&quot;
}

}

Sample Response: Job Successful
copy
{
    "status": "success",
    "data": {
        "job_id": 2000000110044,
        "status": "Completed",
        "operation": "insert",
        "project_details": {
            "project_name": "EmployeeDatabase",
            "id": 4000000006007
        }
        "query": [
            {
                "table_id": 3376000000165511,
                "details": {
                    "object_url" : "https://zylker-emp-development.zohostratus.com/employees/emp_rec.csv"
                }
            }
        ],
        "callback": {
            "url": "https://hr.zylker.com/es/EmpRecords/_callback.php",
            "headers": {
                "src": "ZCatalyst",
                "operation": "bulkwriteAPI"
            },
            "params": {
                "project_name": "EmployeeDatabase"
            }
        },
        "created_by": {
            "zuid": 3000000006111,
            "is_confirmed": true,
            "email_id": "emma@zylker.com",
            "first_name": "Amelia",
            "last_name": "Burrows",
            "user_id": 671930409
        },
        "created_time": "Oct 05, 2020 07:25 PM",
        "results": {
            "download_url": "https://api.catalyst.zoho.com/baas/v1/bulk/write/2000000110013/download",
            "description": "Bulk WRITE job completed. ",
            "details": [
                {
                    "table_id": 3376000000165511,
                    "records_processed": 176
                }
            ]
        }
    }
}

View more

Sample Response: Job Failed
copy
{
    "status": "success",
    "data": {
        "job_id": 2000000110044,
        "status": "Failed",
        "operation": "insert",
        "project_details": {
            "project_name": "EmployeeDatabase",
            "id": 4000000006007
        }
        "query": [
            {
                "table_id": 3376000000165511,
                "details": {
                    "object_url" : "https://zylker-emp-development.zohostratus.com/employees/emp_rec.csv"
                }
            }
        ],
        "callback": {
            "url": "https://hr.zylker.com/es/EmpRecords/_callback.php",
            "headers": {
                "src": "ZCatalyst",
                "operation": "bulkwriteAPI"
            },
            "params": {
                "project_name": "EmployeeDatabase"
            }
        },
        "created_by": {
            "zuid": 3000000006111,
            "is_confirmed": true,
            "email_id": "emma@zylker.com",
            "first_name": "Amelia",
            "last_name": "Burrows",
            "user_id": 671930409
        },
        "created_time": "Oct 05, 2020 07:25 PM",
        "results": {
            "description": "The reference_column 'DeptID' in fk_mapping of table 3376000000165511 is not a unique column",
            "details": [ ]
        }
    }
}

View more

Yes

Thank you for your feedback!

Send your feedback to us

Skip

Submit