GetImportTree

GET

/api/v1/t/{tenant}/ingestion/imports/{importId}/tree

curl --request GET \
  --url https://example.com/api/v1/t/example/ingestion/imports/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/tree

Parameters

Path Parameters

tenant

required

string

Tenant slug

importId

required

string format: uuid

Header Parameters

X-Import-Folder

string

Query Parameters

cursor

string

limit

integer format: int32

Responses

200

OK

Media typeapplication/json

object

folder

required

string

folders

required

Array<object>

object

path

required

string

name

required

string

fileCount

required

integer format: int32

folderCount

required

integer format: int32

hasRule

required

boolean

mapped

required

boolean

files

required

Array<object>

object

index

required

integer format: int32

path

required

string

name

required

string

sizeBytes

required

integer format: int64

contentType

required

null | string

nameReplaced

required

boolean

skipReason

required

One of:

null

null

unknown

Allowed values: SystemFile Empty Shortcut UnsafePath Unsupported Unmapped

conflict

required

One of:

null

null

unknown

Allowed values: Duplicate FileTooLarge TypeNotAllowed Encrypted Corrupt RatioExceeded AmbiguousFile FileNotWritable CsvRowWithoutFile CsvRowAmbiguous CsvFileTwice CsvValueInvalid

partial

required

boolean

nextCursor

required

null | string

Example

{
  "files": [
    {
      "skipReason": "SystemFile",
      "conflict": "Duplicate"
    }
  ]
}

400

Bad Request

Media typeapplication/problem+json

object

type

null | string

title

null | string

status

null | integer format: int32

detail

null | string

instance

null | string

errors

object

key

additional properties

Array<string>

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example",
  "errors": {
    "additionalProperty": [
      "example"
    ]
  }
}

403

Forbidden

Media typeapplication/problem+json

object

type

null | string

title

null | string

status

null | integer format: int32

detail

null | string

instance

null | string

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

404

Not Found

429

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

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}