Quick Start: Bulk API

You process a set of records by creating a job that contains one or more batches. The job specifies which object is being processed and what type of operation is being used. Ingest jobs are defined by CSV, XML, JSON, or binary attachments. Query jobs are defined by a SOQL statement.

A job is represented by the JobInfo resource. This resource is used to create a new job, get status for an existing job, and change status for a job.

Salesforce provides an additional API, Bulk API 2.0, which uses the REST API framework to provide similar capabilities to Bulk API. Bulk API 2.0 simplifies the job creation and monitoring process. For more information on Bulk API 2.0, see the Bulk API 2.0 Developer Guide.

  1. Step One: Create a Job

    Create a job by sending a POST request to this URI. The request body identifies the type of object processed in all associated batches.

  2. Step Two: Monitor a Job

    You can monitor a Bulk API job in Salesforce. The monitoring page tracks jobs and batches created by any client application, including Data Loader or any client application that you write.

  3. Step Three: Close a Job

    Close a job by sending a POST request to this URI. The request URI identifies the job to close. When a job is closed, no more batches can be added.

  4. Step Four: Get Job Details

    Get all details for an existing job by sending a GET request to this URI.

  5. Step Five: Abort a Job

    Abort an existing job by sending a POST request to this URI. The request URI identifies the job to abort. When a job is aborted, no more records are processed. If changes to data have been committed, they aren’t rolled back.