Skip to content
AcrivaDocs

CancelImport

POST
/api/v1/t/{tenant}/ingestion/imports/{importId}/cancel
curl --request POST \
  --url https://example.com/api/v1/t/example/ingestion/imports/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/cancel \
  --header 'Content-Type: application/json' \
  --data '{ "version": 1 }'

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters”
tenant
required
string

Tenant slug

importId
required
string format: uuid

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
version
required
integer format: uint32
Examplegenerated
{
  "version": 1
}

Responses

Section titled “ Responses ”

200

Section titled “200”

OK

Media typeapplication/json
object
id
required
string format: uuid
name
required
string
kind
required
Allowed values: Archive Folder
state
required
Allowed values: Uploading Uploaded Mapped DryRunDone Running Finished Cancelled Failed Discarded
activity
required
Allowed values: None Indexing DryRun
activityFilesDone
required
integer format: int32
declaredBytes
required
integer format: int64
declaredFiles
required
null | integer format: int32
upload
required
One of:
null
fileCount
required
integer format: int32
folderCount
required
integer format: int32
mappingVersion
required
integer format: int32
hasCsv
required
boolean
cancelReason
required
One of:
null
failureReason
required
One of:
null
createdBy
required
string format: uuid
createdAt
required
string format: date-time
startedBy
required
null | string format: uuid
startedAt
required
null | string format: date-time
cancelledBy
required
null | string format: uuid
endedAt
required
null | string format: date-time
uploadExpiresAt
required
string format: date-time
lastChangedAt
required
string format: date-time
version
required
integer format: uint32
Example
{
  "kind": "Archive",
  "state": "Uploading",
  "activity": "None",
  "cancelReason": "ByUser",
  "failureReason": "Unreadable"
}

400

Section titled “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>
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example",
  "errors": {
    "additionalProperty": [
      "example"
    ]
  }
}

403

Section titled “403”

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

404

Section titled “404”

Not Found

409

Section titled “409”

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

429

Section titled “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
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}