Export Data (Asynchronous)
Large sets of data can be exported from tables or reports using the Asynchronous Export API. This process involves creating an export job, monitoring its status, and downloading the data upon successful completion.
Limitations:
- The exported data will be available for download only for one hour after the job completes.
- A maximum of 5 concurrent export jobs is allowed per organization.
Work flow of Bulk Export API is as follows:
1. Create Export Job:
- Initiate an export operation using the Create Export Job API.
- A unique JOBID will be returned in the response. This JOBID is required to track the progress of the export job.
2. Check Export Job Status:
- Use the Get Export Job Details API to periodically monitor the status of the export job (e.g., every 10 seconds).
- Include the JOBID in the request to get the current status.
- The response will contain a JOBCODE indicating the state of the job.
JOBCODE and Status Messages:
| JOBCODE | Status Message | Description |
|---|---|---|
1001 | JOB NOT INITIATED | Export job has been acknowledged but not started. Wait and retry. |
1002 | JOB IN PROGRESS | Export is currently being processed. Continue polling. |
1003 | ERROR OCCURRED | An error occurred. Stop polling and contact support for assistance. |
1004 | JOB COMPLETED | Export process completed successfully. Proceed to download the data. |
1005 | JOB NOT FOUND | Provided JOBID is invalid. Stop polling and verify the JOBID. |
Evaluating Export Job Status Using JOBCODE:
- If the JOBCODE is 1001 or 1002, wait and continue polling.
- If the JOBCODE is 1003, stop checking and contact support.
- If the JOBCODE is 1005, validate the provided JOBID and terminate the request.
- If the JOBCODE is 1004, the job is complete. Use the Download Exported Data API to retrieve the exported data.
3. Download Exported Data:
Once the export job is complete, use the Download Exported Data API to download the exported file.