Import Data (Asynchronous)
Bulk data can be imported into a new or existing table using the Asynchronous Import API. The process involves creating an import job, monitoring its progress, and retrieving the final status upon completion.
Limitations:
- The import job summary is retained only for one hour after job completion.
- A maximum of 5 simultaneous import jobs is allowed per organization.
- A maximum file size of 100 MB can be imported.
Work flow of Asynchronous Import API is as follows:
1. Create Import Job:
- Initiate the import by calling the Create Import Job API.
- A unique JOBID will be returned in the response, which serves as the reference for tracking the import job.
2. Check Job Status:
- Use the Get Import Job Details API to monitor the status of the import job.
- The JOBID must be used in the request to check the status periodically (e.g., every 10 seconds).
- The response will include a JOBCODE, which indicates the current state of the job.
JOBCODE and Status Messages:
| JOBCODE | Status Message | Description |
|---|---|---|
1001 | JOB NOT INITIATED | Job creation acknowledged but not yet started. Retry after a short delay. |
1002 | JOB IN PROGRESS | Job is currently being processed. Continue polling. |
1003 | ERROR OCCURRED | An error occurred during the import. Stop polling and check the error message. |
1004 | JOB COMPLETED | The import process has successfully completed. Import summary is available in the response. |
1005 | JOB NOT FOUND | The provided JOBID is invalid. Stop polling and verify the JOBID. |
Handling Import Job Status Based on JOBCODE
- If the JOBCODE is 1001 or 1002, wait for a few seconds and repeat the status check.
- If the JOBCODE is 1003, stop the status check and inspect the error message for details.
- If the JOBCODE is 1005, verify the validity of the JOBID and terminate the status check.
- If the JOBCODE is 1004, the job is complete, and the import summary will be returned.