Database tables

Import data in the specified table if the authorized user has access to the related database's workspace. This endpoint is asynchronous and return the created job to track the progress of the task.

post/api/database/tables/{table_id}/import/async/

Path parameters

table_idinteger required

Import data into the table related to the provided value.

Request body

importer_typestring

The frontend importer identifier used to parse the file.

original_file_namestring

The original name of the uploaded file.

Response

idinteger required
typestring required

The type of the job.

progress_percentageinteger required

A percentage indicating how far along the job is. 100 means that it's finished.

statestring required

Indicates the state of the import job.

human_readable_errorstring

A human readable error message indicating what went wrong.

error_codestring

A machine readable error code indicating why the job failed.

created_onstring date-time required
updated_onstring date-time required
database_idinteger required

Database id where the table will be created.

namestring

The name of the new table.

table_idinteger

Table id where the data will be imported.

first_row_headerboolean
importer_typestring

The frontend importer identifier used to parse the file.

original_file_namestring

The original name of the uploaded file.

Changes

Changed in 2 of the 6 revisions of this API.4

    • added the new optional request property configuration/import_fields (media type: application/json)

      new-optional-request-property

    • added the new optional request property configuration/import_fields (media type: application/x-www-form-urlencoded)

      new-optional-request-property

    • added the new optional request property configuration/import_fields (media type: multipart/form-data)

      new-optional-request-property

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • added the optional property error_code to the response with the 202 status

      response-optional-property-added