Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

StartTableDataImportJob

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.

Request Syntax


POST /workbooks/workbookId/tables/tableId/import HTTP/1.1
Content-type: application/json

{
   "clientRequestToken": "string",
   "dataFormat": "string",
   "dataSource": { 
      "dataSourceConfig": { 
         "dataSourceUrl": "string"
      }
   },
   "importOptions": { 
      "delimitedTextOptions": { 
         "dataCharacterEncoding": "string",
         "delimiter": "string",
         "hasHeaderRow": boolean,
         "ignoreEmptyRows": boolean
      },
      "destinationOptions": { 
         "columnMap": { 
            "string" : { 
               "columnIndex": number
            }
         }
      }
   }
}

URI Request Parameters

The request uses the following URI parameters.

tableId

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.

Length Constraints: Fixed length of 36.

Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}

Required: Yes

workbookId

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.

Length Constraints: Fixed length of 36.

Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}

Required: Yes

Request Body

The request accepts the following data in JSON format.

clientRequestToken

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.

Type: String

Length Constraints: Minimum length of 32. Maximum length of 64.

Pattern: ^(?!\s*$).+

Required: Yes

dataFormat

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

Type: String

Valid Values: DELIMITED_TEXT

Required: Yes

dataSource

The source of the data that is being imported. The size of source must be no larger than 100 MB. Source must have no more than 100,000 cells and no more than 1,000 rows.

Type: ImportDataSource object

Required: Yes

importOptions

The options for customizing this import request.

Type: ImportOptions object

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "jobId": "string",
   "jobStatus": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

jobId

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: ^[^\n\r\x00\x08\x0B\x0C\x0E\x1F]*$

jobStatus

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

Type: String

Valid Values: SUBMITTED | IN_PROGRESS | COMPLETED | FAILED

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient access to perform this action. Check that the workbook is owned by you and your IAM policy allows access to the resource in the request.

HTTP Status Code: 403

InternalServerException

There were unexpected errors from the server.

HTTP Status Code: 500

RequestTimeoutException

The request timed out.

HTTP Status Code: 504

ResourceNotFoundException

A Workbook, Table, App, Screen or Screen Automation was not found with the given ID.

HTTP Status Code: 404

ServiceQuotaExceededException

The request caused service quota to be breached.

HTTP Status Code: 402

ServiceUnavailableException

Remote service is unreachable.

HTTP Status Code: 503

ThrottlingException

Tps(transactions per second) rate reached.

HTTP Status Code: 429

ValidationException

Request is invalid. The message in the response contains details on why the request is invalid.

HTTP Status Code: 400