POST

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

http://honeycode.{region}.amazonaws.com/workbooks/{workbookId}/tables/{tableId}/import

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.

Access Token Required: API Key

Path Parameters

workbookIdstringrequired

The ID of the workbook where the rows are being imported. If a workbook with the specified id could not be found, this API throws ResourceNotFoundException.

tableIdstringrequired

The ID of the table where the rows are being imported. If a table with the specified id could not be found, this API throws ResourceNotFoundException.

Body Params

dataFormatstringrequired

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

dataSourceobjectrequired

An object that has details about the source of the data that was submitted for import.

importOptionsobjectrequired

An object that contains the options specified by the sumitter of the import request.

clientRequestTokenstringrequired

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. Note that request tokens are valid only for a few minutes. You cannot use request tokens to dedupe requests spanning hours or days.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url 'http://honeycode.{region}.amazonaws.com/workbooks/{workbookId}/tables/{tableId}/import' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

1curl --request POST \ 2 --url 'http://honeycode.{region}.amazonaws.com/workbooks/{workbookId}/tables/{tableId}/import' \ 3 --header 'accept: application/json' \ 4 --header 'content-type: application/json'