Download Bulk Read Result

Purpose

To download the bulk read job as a CSV file. The file needs to be in .zip format. Extract it to get the CSV file.

Request Details

Request URL

https://<base_url>/api/bulk/v2/<account_owner_name>/<app_link_name>/report/<report_link_name>/read/<job_id>/result

where job_id is the unique ID of the bulk read job.

Header

KeyValueDescription
AuthorizationZoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxfAn authentication token (authtoken) allows users to access apps and APIs without having to enter their login credentials each time.

Scope

scope=ZohoCreator.bulk.READ

where,

base_urlZoho Creator:
The base URL of your Creator account
For example, it's creator.zoho.com if your account belongs to Zoho's US DC, and is creator.zoho.eu if it belongs to Zoho's EU DC.

Zoho Creator On-premise:
The base URL specific to your Zoho Creator On-premise account. This URL will be either https://host_name:port_number (learn more) or the hostname of the server where Creator On-prem is running.
account_owner_namethe username of the Creator account's owner
app_link_namethe link name of the target application
report_link_namethe link name of the target report
readname of the operation performed
job_id unique ID of the bulk read job.

Request method

GET

Response Header

recordCursor - To be used in the subsequent requests(Valid for 15mins)

Sample Result

CSV

Note

  • When you’re fetching batches of records and have reached the last batch, the record_cursor will not be received in the last batch. For example, if you are fetching five hundred thousand records in two batches of two hundred thousand records and one batch of one hundred thousand records (last batch), the record_cursor will not be received in the last batch of one hundred thousand records.

Sample Request

Copiedcurl "https://creator.zoho.com/api/bulk/v2/jason18/zylker-store/report/All_Orders/read/{0}/result"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"