Skip to content

UploadDataTableImport

POST
/api/v1/t/{tenant}/data-tables/{tableKey}/imports
curl --request POST \
--url https://example.com/api/v1/t/example/data-tables/example/imports \
--header 'Content-Type: multipart/form-data' \
--form file=@file \
--form sheet=example
tenant
required
string

Tenant slug

tableKey
required
string
Media typemultipart/form-data
object
file
required
string format: binary
sheet
string
<= 31 characters

Created

Media typeapplication/json
object
importId
required
string format: uuid
format
required
Allowed values: Xlsx Csv Json Ndjson
sourceColumns
required
Array<string>
suggestedMapping
required
object
key
additional properties
string
sampleRows
required
Array<object>
object
key
additional properties
string
errors
required
Array<object>
object
row
required
integer format: int32
column
required
null | string
message
required
string
code
required
string
rowCount
required
integer format: int32
sha256
required
string
expiresAt
required
string format: date-time
sheets
required
Array<string>
sheet
required
null | string
Example
{
"format": "Xlsx"
}

Bad Request

Media typeapplication/problem+json
object
type
null | string
title
null | string
status
null | integer format: int32
detail
null | string
instance
null | string
Examplegenerated
{
"type": "example",
"title": "example",
"status": 1,
"detail": "example",
"instance": "example"
}

Forbidden

Media typeapplication/problem+json
object
type
null | string
title
null | string
status
null | integer format: int32
detail
null | string
instance
null | string
Examplegenerated
{
"type": "example",
"title": "example",
"status": 1,
"detail": "example",
"instance": "example"
}

Not Found

Conflict

Media typeapplication/problem+json
object
type
null | string
title
null | string
status
null | integer format: int32
detail
null | string
instance
null | string
Examplegenerated
{
"type": "example",
"title": "example",
"status": 1,
"detail": "example",
"instance": "example"
}

Payload Too Large

Media typeapplication/problem+json
object
type
null | string
title
null | string
status
null | integer format: int32
detail
null | string
instance
null | string
Examplegenerated
{
"type": "example",
"title": "example",
"status": 1,
"detail": "example",
"instance": "example"
}

Too Many Requests

Media typeapplication/problem+json
object
type
null | string
title
null | string
status
null | integer format: int32
detail
null | string
instance
null | string
Examplegenerated
{
"type": "example",
"title": "example",
"status": 1,
"detail": "example",
"instance": "example"
}

Service Unavailable

Media typeapplication/problem+json
object
type
null | string
title
null | string
status
null | integer format: int32
detail
null | string
instance
null | string
Examplegenerated
{
"type": "example",
"title": "example",
"status": 1,
"detail": "example",
"instance": "example"
}