Check Bulk Write Status
Description
You can execute this API to manually check the status of the bulk write job that you initiated previously.
If you had not configured a callback URL in your JSON request, you must check the job status yourself by executing this API. You must use the job_id that is sent to you in the automatic in-progress response when you initiated the bulk write operation, to check the job status subsequently.
The JSON response for the success state will contain a download URL, where you can download a CSV report file that will contain the details of the job execution. It will list all the records that were skipped from being written along with the reasons.
The JSON response for the failed state will contain a description of the error occurred in the job processing, and its details.
Request URL
https://api.catalyst.zoho.com/baas/v1/project/{project_id}/bulk/write/{job_id}
project_id - The unique ID of the project
job_id - The unique ID of the job
Request Header
Authorization: Zoho-oauthtoken 1000.910***************************16.2f****************************57
Request Method
GET
Scope
scope=ZohoCatalyst.tables.bulk.CREATE
Sample Request
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
{
"status": "success",
"data": {
"job_id": 2000000110044,
"status": "In-Progress",
"operation": "insert",
"project_details": {
"project_name": "EmployeeDatabase",
"id": 4000000006007
}
"query": [
{
"table_id": 3376000000165511,
"details": {
"file_id": 3376000000363098
}
}
],
"callback": {
"url": "https://hr.zylker.com/en/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:33 PM"
}
} Sample Response: Job Successful
{
"status": "success",
"data": {
"job_id": 2000000110044,
"status": "Completed",
"operation": "insert",
"project_details": {
"project_name": "EmployeeDatabase",
"id": 4000000006007
}
"query": [
{
"table_id": 3376000000165511,
"details": {
"file_id": 3376000000363098
}
}
],
"callback": {
"url": "https://hr.zylker.com/en/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
}
]
}
}
} Sample Response: Job Failed
{
"status": "success",
"data": {
"job_id": 2000000110044,
"status": "Failed",
"operation": "insert",
"project_details": {
"project_name": "EmployeeDatabase",
"id": 4000000006007
}
"query": [
{
"table_id": 3376000000165511,
"details": {
"file_id": 3376000000363098
}
}
],
"callback": {
"url": "https://hr.zylker.com/en/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": [ ]
}
}
}