- All Products
- Sales
- Marketing
- Service
- Finance
- Email & Collaboration
- HR
- Legal
- Security & IT Management
- BI & Analytics
- Project Management
- Developer Platforms
- Bundles
- Marketplace
Do more with your Zoho products
Get the Status of the Bulk Read Job
Purpose
To get the details of a bulk read job performed previously.
Request Details
Request URL
https://<base_url>/api/bulk/v2/<account_owner_name>/<app_link_name>/report/<report_link_name>/read/<job_id>
Header
| Key | Value | Description |
| Authorization | Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf | 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 AppCreator account For example, the base URL is either https://host_name:port_number (learn more) or appcreatordemo.manageengine.com (hostname of the server where ManageEngine AppCreator is running). |
| account_owner_name | the username of the AppCreator 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 Structure
- operationstring
Specifies the type of action the API completed. Sample - "operation": "read"
- created_bystring
Specifies the name of the user who initiated the bulk read job. Sample - "created_by": "jason18",
- created_timestring
Specifies the time period of when the bulk read job was initialized.
- statusstring
Specifies the current status of the bulk read job. Example: "status": "IN PROGRESS" , "COMPLETED" , "FAILED".
- idstring
Specifies the unique identifier of the bulk read job. Sample - "id": "1000010760002".
- resultJSON Object
Available only after the completion of the job. Please refer to the below section for information on the "result" JSON object.
"result" Properties
- countInteger
Specifies the actual number of records exported. Sample - "count": 14567
- download_urlstring
Specifies the URL that contains the CSV file. User can send a GET request with your api domain attached to the download URL to download the file. Sample - "/api/bulk/v2/jason18/zylker-store/report/All_Orders/read/2000000010003/result/"
- record_cursorstring
Token will be valid for a period of 15mins. Request for further fetch of request with this particular cursor should reach the server within 15mins.
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.
- To learn about the Bulk Read API limits, refer to this page.
Sample Request
Copiedcurl "https://appcreatordemo.manageengine.com/api/bulk/v2/jason18/zylker-store/report/All_Orders/read/{0}"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"Sample Response:
Copied{
"code": 3000,
"details": {
"created_time": "06-Sep-2021 16:47:18",
"id": "2000000018003",
"operation": "read",
"created_by": "jason18",
"status": "In-progress"
}
}Sample response of job completed
Copied{
"code": 3000,
"details": {
"result": {
"count": 16,
"download_url": "/api/bulk/v2/jason_18/one/report/b_Report/read/2000000010003/result"
},
"created_time": "06-Sep-2021 16:47:18",
"id": "2000000010003",
"operation": "read",
"created_by": "jason_18",
"status": "Completed"
}
}