Jobs API Overview
The Jobs API is for Administrator use only. Do not use these endpoints on your customer-facing frontends.
The jobs endpoint displays the status of a number of endpoints that function as jobs, for example, product import and export, and duplicating hierarchies.
The job Object
| Name | Required | Type | Description |
|---|---|---|---|
type | Required | string | Always pim-job. |
id | Required | string | A unique ID generated when a job is created. |
attributes | Required | object | The attributes that describe the job. |
meta | Required | object | The attributes that make up the meta object. |
The attributes object
| Name | Type | Description |
|---|---|---|
completed_at | string | The date and time a job is completed. |
created_at | string | The date and time a job is created. |
started_at | string | The date and time a job is started. |
status | string | The status of the job.
|
type | string | The job type.
|
updated_at | string | The date and time a job was updated. |
The meta Object
| Name | Type | Description |
|---|---|---|
request_id | string | Applies to all job types. A unique request ID is generated when a job is created. |
file_locations | string | If the job type is product_export, a link to the file created when running a job |
filter | string | The entities included in the job. For example, if the job type is product-export, the PXM products included in the export. |