ImportJobDto

DTO representing an import job status

Properties

Name	Type	Description
code	string	Unique code for this import job
Unique code for this import job
status	enum	Queued InProgress Completed Failed Cancelled Draft
Queued InProgress Completed Failed Cancelled Draft
totalItems	integer	Total number of items to be imported
Total number of items to be imported
processedItems	integer	Number of items processed so far
Number of items processed so far
successCount	integer	Number of items successfully imported
Number of items successfully imported
failureCount	integer	Number of items that failed to import
Number of items that failed to import
errorMessage	string	Why the job as a whole failed. Set only when Status is Failed, and only for job-level failures (deleted connection, unsupported platform, unhandled error) - per-client failure reasons come from the import job clients endpoint instead.
Why the job as a whole failed. Set only when Status is Failed, and only for job-level failures (deleted connection, unsupported platform, unhandled error) - per-client failure reasons come from the import job clients endpoint instead.
enrichFromCompaniesHouse	boolean	Whether Companies House enrichment is enabled
Whether Companies House enrichment is enabled
startedDate	string	When the job started processing
When the job started processing
completedDate	string	When the job completed
When the job completed
createdDate	string	When the job was created
When the job was created

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