The model representing a bulk job that can load data asynchronously.
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
created |
OffsetDateTime | ➖ | The ISO 8601 zoned date time when this record was created. | 2017-01-02T02:00:00Z |
createdBy |
Optional<String> | ➖ | The identifier of the user that created this record. | hporter |
lastModified |
OffsetDateTime | ➖ | The ISO 8601 zoned date time when this record was updated. | 2019-02-12T03:00:00Z |
lastModifiedBy |
Optional<String> | ➖ | The identifier of the user that last updated this record. | hporter |
id |
Optional<String> | ➖ | Bulk job identifier | 766d1986-9aaa-454f-86f5-d605c45b3131 |
description |
Optional<String> | ➖ | Description of the bulk job. | Q1 Contact Import |
url |
String | ✔️ | URL of the destination public API being called. This can be the full path or the relative path to the entity. Variables in the URL should remain generic so that you can specify their value in each record with the pathParams field. |
/contacts/{id} |
operation |
BulkJobOperation | ✔️ | Operation to be performed in the destination API. | PUT |
headers |
Map<String, String> | ➖ | Headers to be passed on the destination API. Values must NOT be null. | { "header1": "header1Value", "header2": "header2Value" } |
queryParams |
Map<String, String> | ➖ | Query Params to be passed on to the destination API. Values must NOT be null. | { "param1": "param1Value", "param2": "param2Value" } |
started |
OffsetDateTime | ➖ | The ISO 8601 zoned date time when the job started. | 2017-01-02T02:00:00Z |
completed |
OffsetDateTime | ➖ | The ISO 8601 zoned date time when the job completed. | 2017-01-02T02:30:00Z |
status |
Optional<BulkJobStatus> | ➖ | The current status of the bulk job. | COMPLETED |
totalRecords |
Optional<Long> | ➖ | Total number of records uploaded for the bulk job. | 5000 |
successful |
Optional<Long> | ➖ | Total number of records that were successfully processed by the bulk job. | 4950 |
failed |
Optional<Long> | ➖ | Total number of records that were unsuccessfully processed by the bulk job. | 50 |