Skip to content

GetImportDryRun

GET
/api/v1/t/{tenant}/ingestion/imports/{importId}/dry-run
curl --request GET \
--url https://example.com/api/v1/t/example/ingestion/imports/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/dry-run
tenant
required
string

Tenant slug

importId
required
string format: uuid

OK

Media typeapplication/json
object
state
required
Allowed values: Running Finished Abandoned
mappingVersion
required
integer format: int32
current
required
boolean
computedFor
required
string format: uuid
startedAt
required
string format: date-time
finishedAt
required
null | string format: date-time
filesTotal
required
integer format: int32
filesDone
required
integer format: int32
documentTypes
required
Array<object>
object
documentTypeId
required
null | string format: uuid
documents
required
integer format: int32
fileTypes
required
Array<object>
object
fileTypeId
required
string format: uuid
created
required
integer format: int32
found
required
integer format: int32
conflicts
required
Array<object>
object
kind
required
Allowed values: Duplicate FileTooLarge TypeNotAllowed Encrypted Corrupt RatioExceeded AmbiguousFile FileNotWritable CsvRowWithoutFile CsvRowAmbiguous CsvFileTwice CsvValueInvalid
count
required
integer format: int32
examples
required
Array<object>
object
fileIndex
required
null | integer format: int32
path
required
null | string
csvRow
required
null | integer format: int32
csvColumn
required
null | string
duplicate
required
One of:
null
skippedFiles
required
integer format: int32
unmappedFiles
required
integer format: int32
creditsEstimated
required
integer format: int32
creditsLeft
required
null | integer format: int32
bytesToFile
required
integer format: int64
storageLeftBytes
required
integer format: int64
retentionEnded
required
integer format: int32
retentionUnknown
required
integer format: int32
Example
{
"state": "Running",
"conflicts": [
{
"kind": "Duplicate"
}
]
}

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

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"
}