API Docs / Schemas / ImportJobDto

ImportJobDto

DTO representing an import job status

Properties

Name Type Description
codestring

Unique code for this import job

Unique code for this import job

statusenum

Queued InProgress Completed Failed Cancelled

Queued InProgress Completed Failed Cancelled

totalItemsinteger

Total number of items to be imported

Total number of items to be imported

processedItemsinteger

Number of items processed so far

Number of items processed so far

successCountinteger

Number of items successfully imported

Number of items successfully imported

failureCountinteger

Number of items that failed to import

Number of items that failed to import

enrichFromCompaniesHouseboolean

Whether Companies House enrichment is enabled

Whether Companies House enrichment is enabled

startedDatestring

When the job started processing

When the job started processing

completedDatestring

When the job completed

When the job completed

createdDatestring

When the job was created

When the job was created

JSON Example

{
  "code": "string",
  "status": "Queued",
  "totalItems": 0,
  "processedItems": 0,
  "successCount": 0
}

Used By Operations