GET

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

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

The DescribeTableDataImportJob API allows you to retrieve the status and details of a table data import job.

Access Token Required: API Key

Path Parameters

workbookIdstringrequired

The ID of the workbook into which data was imported. If a workbook with the specified id could not be found, this API throws ResourceNotFoundException.

tableIdstringrequired

The ID of the table into which data was imported. If a table with the specified id could not be found, this API throws ResourceNotFoundException.

jobIdstringrequired

The ID of the job that was returned by the StartTableDataImportJob request. If a job with the specified id could not be found, this API throws ResourceNotFoundException.

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 GET \
2     --url 'http://honeycode.{region}.amazonaws.com/workbooks/{workbookId}/tables/{tableId}/import/{jobId}' \
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 GET \ 2 --url 'http://honeycode.{region}.amazonaws.com/workbooks/{workbookId}/tables/{tableId}/import/{jobId}' \ 3 --header 'accept: application/json' \ 4 --header 'content-type: application/json'