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 |
Queued InProgress Completed Failed Cancelled | ||
| 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 | ||
| 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 | ||
JSON Example
{
"code": "string",
"status": "Queued",
"totalItems": 0,
"processedItems": 0,
"successCount": 0
}
Used By Operations
-
POST
Import from platform (sync-when-fast, async-when-slow)
/api/tenants/{tenant}/clients/import/from-connection
-
POST
Import from platform (sync-when-fast, async-when-slow)
/api/tenants/{tenant}/clients/import/from-connection
-
POST
Import from platform (sync-when-fast, async-when-slow)
/api/tenants/{tenant}/clients/import/from-connection
-
GET
Get Import Job Status
/api/tenants/{tenant}/import-jobs/{code}