Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1415122102.4 KB

The StartTableDataImportJob API allows you to start an import job on a table. This API will only return the id of the job that was started. To find out the status of the import request, you need to call the DescribeTableDataImportJob API.

post/workbooks/{workbookId}/tables/{tableId}/import

Path parameters

workbookIdstring required
<p>The ID of the workbook where the rows are being imported.</p> <p> If a workbook with the specified id could not be found, this API throws ResourceNotFoundException. </p>
tableIdstring required
<p>The ID of the table where the rows are being imported.</p> <p> If a table with the specified id could not be found, this API throws ResourceNotFoundException. </p>

Request body

dataFormat'DELIMITED_TEXT' required

The format of the data that is being imported. Currently the only option supported is "DELIMITED_TEXT".

clientRequestTokenstring required
<p> The request token for performing the update action. Request tokens help to identify duplicate requests. If a call times out or fails due to a transient error like a failed network connection, you can retry the call with the same request token. The service ensures that if the first call using that request token is successfully performed, the second call will not perform the action again. </p> <p> Note that request tokens are valid only for a few minutes. You cannot use request tokens to dedupe requests spanning hours or days. </p>

Response

Success

jobIdstring required

The id that is assigned to this import job. Future requests to find out the status of this import job need to send this id in the appropriate parameter in the request.

jobStatus'SUBMITTED' | 'IN_PROGRESS' | 'COMPLETED' | 'FAILED' required

The status of the import job immediately after submitting the request.