Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.
Upload Complete
Notifies Salesforce servers that the upload of job data is complete and is ready for
processing. You can’t add any more job data. This request is required for every Bulk API 2.0
ingest job. If you don't make this request, processing of your data does not start.
URI: /services/data/vXX.X/jobs/ingest/jobID
Availability: This resource is available in API version 41.0 and later.
Formats: JSON
HTTP Method: PATCH
Authentication: Authorization: Bearer token
Parameters: None.
Request Body
| Property | Type | Description | Required or Optional |
|---|---|---|---|
| state | JobStateEnum | The state to update the job to. Use UploadComplete to tell Salesforce servers that the job is ready for processing. | Required |
Response Body
| Property | Type | Description |
|---|---|---|
| apiVersion | string | The API version that the job was created in. |
| assignmentRuleId | id | The ID of the assignment rule. This property is only shown if an assignment rule is specified when the job is created. |
| columnDelimiter | ColumnDelimiterEnum | The column delimiter used for CSV job data. Values include:
|
| concurrencyMode | ConcurrencyModeEnum | For future use. How the request was processed. Currently only parallel mode is supported. (When other modes are added, the mode will be chosen automatically by the API and will not be user configurable.) |
| contentType | ContentType | The format of the data being processed. Only CSV is supported. |
| contentUrl | URL | The URL to use for Upload Job Data requests for this job. Only valid if the job is in Open state. |
| createdById | string | The ID of the user who created the job. |
| createdDate | dateTime | The date and time in the UTC time zone when the job was created. |
| externalIdFieldName | string | The name of the external ID field for an upsert. |
| id | string | Unique ID for this job. |
| jobType | JobTypeEnum | The job’s type. Values include:
|
| lineEnding | LineEndingEnum | The line ending used for CSV job data. Values include:
|
| object | string | The object type for the data being processed. Empty for jobs created with the consentImport operation. |
| operation | The processing operation for the job. Values include:
|
|
| state | JobStateEnum | The current state of processing for the job. Values include:
|
| systemModstamp | dateTime | Date and time in the UTC time zone when the job finished. |