Download Bulk Read Result
Table of Contents
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>/creator/v2.1/bulk/<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
Key | Value | Description |
Authorization | Zoho-oauthtoken 1000.8cb99dxxxxxx xxxxxxx9be93.9b 8xxxxxxxxxxxxxxxf | An 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_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 |
report_link_name | the link name of the target report |
read | name 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 15 mins)
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://https://www.zohoapis.com/creator/v2.1/bulk/jason18/zylker-store/report/All_Orders/read/{0}/result"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
Copiedresponse = invokeUrl
[
url: "https://www.zohoapis.com/creator/v2.1/bulk/jason18/zylker-store/report/All_Orders/read/137836000000335003/result"
type: GET
connection: "zoho-creator"
];
info response ;
Copiedpackage main.java.org.example;
import okhttp3.HttpUrl;
import okhttp3.OkHttpClient;
import okhttp3.Request;
import org.json.JSONException;
import java.lang.String;
public class BulkReadResult
{
public static void main(String[] args) throws JSONException
{
OkHttpClient client = new OkHttpClient();
HttpUrl.Builder urlBuilder = HttpUrl.parse("https://www.zohoapis.com/creator/v2.1/bulk/jason18/zylker-store/report/All_Orders/read/137836000000335003/result").newBuilder();
Request request = new Request.Builder()
.url(urlBuilder.toString())
.method("GET", null)
.addHeader("Authorization", "Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf")
.build();
try
{
String response = client.newCall(request).execute().body().string();
}
catch (Exception e)
{
System.out.println("Exception while making the API request.");
}
}
}
Copiedlet api_headers = {
"Authorization": "Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
}
try {
let response = fetch("https://www.zohoapis.com/creator/v2.1/bulk/jason18/zylker-store/report/All_Orders/read/137836000000335003/result", {
method: "GET",
headers: api_headers
})
}
catch (exception) {
console.error(exception)
}
Copiedimport requests
api_headers = {
"Authorization": "Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
}
try:
response = requests.get("https://www.zohoapis.com/creator/v2.1/bulk/jason18/zylker-store/report/All_Orders/read/137836000000335003/result", headers=api_headers)
except:
print("Exception while making the API request.")