Download Bulk Insert Result
Table of Contents
Overview
This API downloads the result of a bulk insert job for the specified job_id. The result is provided as a zip file containing a single csv file.
You can filter the output to download successful, failed, or unprocessed records:
- For success, the csv file contains the record IDs of successfully inserted records.
- For failed, the csv file includes the records along with the reason for failure.
- unprocessed, the csv file contains only the records that were not processed.
Note: The job result is available for 3 days after completion. After this period, it will expire.
Request Details
Request URL
https://<base_url>/creator/v2.1/bulk/<account_owner_name>/<app_link_name>/report/<report_link_name>/insert/<job_id>
where job_id is the unique ID of the bulk insert job.
Header
| Key | Value | Description |
| Authorization | Zoho-oauthtoken10 00.8cb99dxxxxx xxxxxxxx9be93.9b 8xxxxxxxxxxxxxxxf | An authentication token (authtoken) allows users to access apps and APIs without entering their login credentials each time. |
| environment | development/stage | Specifies the environment. |
Scope
scope=ZohoCreator.bulk.READ
where,
| base_url | the base URL of your Creator account For example, it's www.zohoapis.com if your account belongs to Zoho's US DC, and is www.zohoapis.eu if it belongs to Zoho's EU DC. |
| account_owner_name | the username of the Creator account's owner |
| app_link_name | the link name of the target application |
| form_link_name | the link name of the target form |
| job_id | unique identifier of the bulk insert job |
Request method
GET
Response Header
recordCursor - To be used in the subsequent requests (Valid for 15 mins)
Note: To know about the Bulk API limits, refer this page.
Parameters
filter | success/failure/unprocessed |
Response Structure
Response will be downloaded as zip.
Success Response :
Failed Records : 
Sample Request
Copiedcurl --location 'https://www.zohoapis.com/creator/v2.1/bulk/jason18/bulk-insert/form/form_name/insert/18420xxxxxxxxxxx07/result?filter=success' \
--header 'Authorization: Bearer 1000.30b0ecxxxxxxxxxxxxxxx8ed8a.07a80xxxxxxxxxxxxxxxxxx6'Copiedresponse = invokeUrl
[
url: "https://www.zohoapis.com/creator/v2.1/bulk/jason18/zylker-store/report/All_Orders/read/13783xxxxxxxxxxxxx03/result?filter=success"
type: GET
connection: "zoho-creator"
];
info response ;CopiedOkHttpClient client = new OkHttpClient().newBuilder()
.build();
MediaType mediaType = MediaType.parse("text/plain");
RequestBody body = RequestBody.create(mediaType, "");
Request request = new Request.Builder()
.url("https://www.zohoapis.com/creator/v2.1/bulk/jason18/bulk-insert/form/form_link/insert/184205xxxxxxxxxxxx7/result?filter=success")
.method("GET", body)
.addHeader("Authorization", "Bearer 1000.30b0ecxxxxxxxxxxxxxxxxx8a.07a80xxxxxxxxxxxxxxxxxxxxxxf6")
.build();
Response response = client.newCall(request).execute();Copiedconst myHeaders = new Headers();
myHeaders.append("Authorization", "Bearer 1000.30b0ec254b0d1c2bda44ce0b9928ed8a.07a8060b59daf68d13f92d5d00be27f6");
const requestOptions = {
method: "GET",
headers: myHeaders,
redirect: "follow"
};
fetch("https://www.zohoapis.com/creator/v2.1/bulk/jason18/bulk-insert/form/form_name/insert/18420xxxxxxxxxxxx07/result?filter=success", requestOptions)
.then((response) => response.text())
.then((result) => console.log(result))
.catch((error) => console.error(error));Copiedlibrary(RCurl)
headers = c(
"Authorization" = "Bearer 1000.30b0ecxxxxxxxxxxxxxxxxxxxxd8a.07a80xxxxxxxxxxxxxxxxxxxxf6"
)
res <- getURL("https://www.zohoapis.com/creator/v2.1/bulk/jason18/bulk-insert/form/form_link/insert/184205xxxxxxxxxxxxx7/result?filter=success", .opts=list(httpheader = headers, followlocation = TRUE))
cat(res)