Salesforce

Salesforce Parallel API

The Parallel API from Salesforce — 1 operation(s) for parallel.

GitHub OpenAPI

Documentation

📖
Documentation
https://developer.salesforce.com/docs/atlas.en-us.api_bulk_v2.meta/api_bulk_v2/
📖
APIReference
https://developer.salesforce.com/docs/atlas.en-us.api_bulk_v2.meta/api_bulk_v2/get_job_info.htm
📖
Authentication
https://developer.salesforce.com/docs/atlas.en-us.api_bulk_v2.meta/api_bulk_v2/bulk_api_2_0_security.htm
📖
Documentation
https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/
📖
GettingStarted
https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_get_started.htm
📖
APIReference
https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_list.htm
📖
Documentation
https://developer.salesforce.com/docs/marketing/marketing-cloud/guide/rest-api.html
📖
GettingStarted
https://developer.salesforce.com/docs/marketing/marketing-cloud/guide/get-started-spec.html
📖
APIReference
https://developer.salesforce.com/docs/marketing/marketing-cloud/references/mc_rest_overview.html
📖
Authentication
https://developer.salesforce.com/docs/marketing/marketing-cloud/guide/access-token-s2s.html
📖
Documentation
https://developer.salesforce.com/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/salesforce/refs/heads/main/openapi/salesforce-parallel-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/salesforce/refs/heads/main/json-schema/salesforce-bulk-job-schema.json

OpenAPI Specification

salesforce-parallel-api-openapi.yml Raw ↑ 
openapi: 3.1.0
info:
  title: Salesforce Bulk API 2.0 Abort Parallel API
  description: 'Salesforce Bulk API 2.0 is a simplified, REST-based interface for bulk data operations that improves on the original Bulk API. It uses a straightforward job model and supports CSV format for ingest and query jobs, enabling processing of millions of records asynchronously.

    '
  version: v63.0
  contact:
    name: Salesforce Developers
    url: https://developer.salesforce.com/
  license:
    name: Salesforce Developer Terms
    url: https://www.salesforce.com/company/legal/agreements/
servers:
- url: https://{instance}.salesforce.com/services/data/v{version}/jobs
  description: Salesforce Bulk API 2.0 jobs endpoint
  variables:
    instance:
      default: yourInstance
      description: 'The Salesforce instance identifier (e.g., na1, eu3, or a My Domain subdomain like mycompany).

        '
    version:
      default: '63.0'
      description: 'The Salesforce API version number (e.g., 63.0). Use the latest supported version for new integrations.

        '
security:
- BearerAuth: []
tags:
- name: Parallel
paths:
  /data/v64.0/jobs/query//resultPages:
    parameters: []
    get:
      tags:
      - Parallel
      summary: Salesforce Get Parallel Results for a Query Job
      description: Retrieves a set of up to 5 job results pages for parallel download.
      operationId: GetParallelResultsforaQueryJob
      parameters:
      - name: Content-Type
        in: header
        description: ''
        required: true
        schema:
          const: application/json
          type: string
          examples:
          - application/json
        example: example_value
      - name: Accept
        in: header
        description: ''
        required: true
        schema:
          type: string
          examples:
          - application/json
        example: example_value
      responses:
        default:
          description: ''
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/GetParallelResultsforaQueryJob'
                - examples:
                  - resultPages:
                    - resultLink: /jobs/query/750R0000000zxr8IAA/results?locator=aBcDeFg4N
                    - resultLink: /jobs/query/750R0000000zxr8IAA/results?locator=HiJkLmN4N
                    - resultLink: /jobs/query/750R0000000zxr8IAA/results?locator=oPQrStU4N
                    - resultLink: /jobs/query/750R0000000zxr8IAA/results?locator=vWxYzz4N
                    - resultLink: /jobs/query/750R0000000zxr8IAA/results?locator=NiKmABC4N
                    nextRecordsUrl: /jobs/query/750R0000000zxr8IAA/resultpages?locator=YcApWm4N
                    done: false
                contentMediaType: application/json
              example:
                resultPages:
                - resultLink: /jobs/query/750R0000000zxr8IAA/results?locator=aBcDeFg4N
                - resultLink: /jobs/query/750R0000000zxr8IAA/results?locator=HiJkLmN4N
                - resultLink: /jobs/query/750R0000000zxr8IAA/results?locator=oPQrStU4N
                - resultLink: /jobs/query/750R0000000zxr8IAA/results?locator=vWxYzz4N
                - resultLink: /jobs/query/750R0000000zxr8IAA/results?locator=NiKmABC4N
                nextRecordsUrl: /jobs/query/750R0000000zxr8IAA/resultpages?locator=YcApWm4N
                done: false
      deprecated: false
      servers:
      - url: https://services
        variables: {}
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    GetParallelResultsforaQueryJob:
      title: GetParallelResultsforaQueryJob
      required:
      - resultPages
      - nextRecordsUrl
      - done
      type: object
      properties:
        resultPages:
          type: array
          items:
            $ref: '#/components/schemas/ResultPage'
          description: ''
          example: []
        nextRecordsUrl:
          type: string
          example: https://www.example.com
        done:
          type: boolean
          example: true
      examples:
      - resultPages:
        - resultLink: /jobs/query/750R0000000zxr8IAA/results?locator=aBcDeFg4N
        - resultLink: /jobs/query/750R0000000zxr8IAA/results?locator=HiJkLmN4N
        - resultLink: /jobs/query/750R0000000zxr8IAA/results?locator=oPQrStU4N
        - resultLink: /jobs/query/750R0000000zxr8IAA/results?locator=vWxYzz4N
        - resultLink: /jobs/query/750R0000000zxr8IAA/results?locator=NiKmABC4N
        nextRecordsUrl: /jobs/query/750R0000000zxr8IAA/resultpages?locator=YcApWm4N
        done: false
    ResultPage:
      title: ResultPage
      required:
      - resultLink
      type: object
      properties:
        resultLink:
          type: string
          example: example_value
      examples:
      - resultLink: /jobs/query/750R0000000zxr8IAA/results?locator=aBcDeFg4N
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: 'OAuth 2.0 Bearer token obtained from the Salesforce OAuth 2.0 token endpoint. Include this token in the Authorization header as "Bearer {access_token}".

        '