Entity description

An ImportJob entity represents an operation that imports records into the system from a specific provider (e.g., Excel file). The import job can either validate the data or execute the import process. It includes details about the job type, progress, status, and provider configuration.

Properties

Name	Description	Type	Example
uid	Unique identifier of the import job	string	`job-xyz789`
provider_type	The type of import provider (`excel`, `import_job`)	string	`excel`
provider_data	The configuration data used by the provider for the import	object	See Provider Data below
job_type	The type of job operation (`validate`, `execute`). `validate` checks for errors; `execute` runs the import	string	`execute`
status	The current status of the import job (`pending`, `processing`, `done`, `error`)	string	`processing`
error_message	Error message if the job failed	string	`null`
progress	Progress of the import job, including total, done, error, and pending records	object	See Progress Properties below
created_at	The creation timestamp in ISO 8601 format	string	`2023-01-15T08:00:00.000Z`
updated_at	The last update timestamp in ISO 8601 format	string	`2023-01-15T08:30:00.000Z`

Provider Data

Excel Provider Configuration

Name	Description	Type	Example
entity_type	Type of entity being imported	string	`products`
original_file_name	Name of the uploaded file	string	`import.xlsx`
fields	Array of field names to be processed	array	`["name", "price", "description"]`
context	Additional context data for the import	object	`{ "currency": "USD" }`

Existing Import Job Configuration

Name	Description	Type	Example
source_import_job_uid	The UID of the import job used for validation	string	`job-abc123`

Progress Properties

Name	Description	Type	Example
total	Total number of records to be processed	number	`100`
done	Number of records successfully processed	number	`42`
error	Number of records that failed processing	number	`3`
pending	Number of records pending processing	number	`55`

Example

{
  "uid": "job-xyz789",
  "provider_type": "excel",
  "provider_data": {
    "entity_type": "products",
    "original_file_name": "import.xlsx",
    "fields": [
      "name",
      "price",
      "description"
    ],
    "context": {
      "currency": "USD"
    }
  },
  "job_type": "execute",
  "status": "processing",
  "error_message": null,
  "progress": {
    "total": 100,
    "done": 42,
    "error": 3,
    "pending": 55
  },
  "created_at": "2023-01-15T08:00:00.000Z",
  "updated_at": "2023-01-15T08:30:00.000Z"
}