- Home
- API reference
- API documentation (JSON/XML)
- Objects
Job object
Description
The Job object is part of a system response and contains the information about a current job.The authentication data is generated from the product. The data can only be determined if a product is specified.
Structure
| JSON Keyword | XML Keyword | Occurs | Type | Format | Description |
|---|---|---|---|---|---|
| created | created | 0 - 1 | string | datetime | The date on which the order was created. |
| updated | updated | 0 - 1 | string | date-time | The date on which the order was last updated. |
| owner | owner | 1 | object | Basic User | The object owner |
| updater | updater | 1 | object | Basic User | The user who performed the last update. |
| status | status | 1 | enum | JobStatusConstants | Defines the status of a job. |
| substatus | sub_status | 0 - 1 | string | Substatus of the job. Substatuses exist depending on the job. | |
| execution | execution | 0 - 1 | string | date-time | The date on which the job is processed by the system. |
| events | events | 0 - n | object | WorkFlowEvent | The workflow events generated by the job. |
| - | type | 1 | string | Type of the job (e.g. contact job=contact, domain job=domain) | |
| subType | sub_type | 0 - 1 | string | The subtype of the job. (e.g.: The SSL certificate type). | |
| action | action | 1 | integer | int64 | The job action |
| id | id | 1 | integer | int64 | The job ID |
| - | object | 1 | string | The object associated with the job, for example, the contact ID or domain name. | |
| - | messages | 0 - n | object | Msg | The notifications contained in the system response, e.g. error messages or notices. |
| - | logs | 0 - n | object | CommonLog | The list of the associated log entries |