Salesforce Status API

openapi: 3.1.0
info:
  title: Salesforce Bulk API 2.0 Abort Status 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: Status
paths:
  /async/64.0/job//batch:
    parameters: []
    get:
      tags:
      - Status
      summary: Salesforce Bulk Check Batch Status
      operationId: BulkCheckBatchStatus
      parameters:
      - name: X-SFDC-Session
        in: header
        description: ''
        required: true
        schema:
          type: string
        example: example_value
      - name: Accept-Encoding
        in: header
        description: ''
        required: true
        schema:
          type: string
          examples:
          - gzip
        example: example_value
      - name: Content-Encoding
        in: header
        description: ''
        required: true
        schema:
          type: string
          examples:
          - gzip
        example: example_value
      responses:
        '200':
          description: OK
          headers:
            Date:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: Thu, 16 Nov 2023 16:19:29 GMT
            Strict-Transport-Security:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: max-age=63072000; includeSubDomains
            X-Content-Type-Options:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: nosniff
            X-XSS-Protection:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: 1; mode=block
            X-Robots-Tag:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: none
            Cache-Control:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: no-cache,must-revalidate,max-age=0,no-store,private
            Content-Encoding:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: gzip
            Transfer-Encoding:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: chunked
          content:
            application/xml:
              schema:
                allOf:
                - $ref: '#/components/schemas/batchInfoList'
                - xml:
                    name: batchInfoList
                    attribute: false
                    wrapped: false
                  examples:
                  - "<batchInfoList>\n\n  <batchInfo>\n\n    <id>751...</id>\n\n    <jobId>750...</jobId>\n\n    <state>Completed</state>\n\n    <createdDate>datetime</createdDate>\n\n    <systemModstamp>datetime</systemModstamp>\n\n    <numberRecordsProcessed>1</numberRecordsProcessed>\n\n    <numberRecordsFailed>0</numberRecordsFailed>\n\n    <totalProcessingTime>403</totalProcessingTime>\n\n    <apiActiveProcessingTime>225</apiActiveProcessingTime>\n\n    <apexProcessingTime>64</apexProcessingTime>\n\n  </batchInfo>\n\n</batchInfoList>"
                contentMediaType: application/xml
              example: "<batchInfoList>\n\n  <batchInfo>\n\n    <id>751...</id>\n\n    <jobId>750...</jobId>\n\n    <state>Completed</state>\n\n    <createdDate>datetime</createdDate>\n\n    <systemModstamp>datetime</systemModstamp>\n\n    <numberRecordsProcessed>1</numberRecordsProcessed>\n\n    <numberRecordsFailed>0</numberRecordsFailed>\n\n    <totalProcessingTime>403</totalProcessingTime>\n\n    <apiActiveProcessingTime>225</apiActiveProcessingTime>\n\n    <apexProcessingTime>64</apexProcessingTime>\n\n  </batchInfo>\n\n</batchInfoList>"
      deprecated: false
      servers:
      - url: https://services
        variables: {}
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /data/v64.0/einstein/ai-evaluations/runs/{runId}:
    parameters: []
    get:
      tags:
      - Status
      summary: Salesforce Get Test Status
      description: Generates a response based on the specified prompt template and input parameters ([documentation](https://developer.salesforce.com/docs/atlas.en-us.chatterapi.meta/chatterapi/connect_resources_prompt_template.htm)).
      operationId: Getteststatus
      parameters:
      - name: runId
        in: path
        description: Evaluation ID
        required: true
        schema:
          type: string
        example: '500123'
      responses:
        '200':
          description: OK
          headers:
            Date:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: Wed, 10 Sep 2025 13:46:26 GMT
            Transfer-Encoding:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: chunked
            Connection:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: keep-alive
            Cache-Control:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: no-cache,must-revalidate,max-age=0,no-store,private
            Set-Cookie:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: CookieConsentPolicy=0:1; path=/; expires=Thu, 10-Sep-2026 13:46:26 GMT; Max-Age=31536000; secure
            Content-Encoding:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: gzip
            X-Content-Type-Options:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: nosniff
            X-Robots-Tag:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: none
            Sforce-Limit-Info:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: api-usage=183/5000000
            Vary:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: Accept-Encoding
            Server:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: sfdcedge
            X-SFDC-Request-Id:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: 9c6b1b17f16e5e4b538e836eb8def249
            X-Request-Id:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: 9c6b1b17f16e5e4b538e836eb8def249
            X-SFDC-Edge-Cache:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: MISS
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Getteststatus'
                - examples:
                  - startTime: '2025-09-10T13:46:14.000Z'
                    status: IN_PROGRESS
                contentMediaType: application/json
              example:
                startTime: '2025-09-10T13:46:14.000Z'
                status: IN_PROGRESS
      deprecated: false
      servers:
      - url: https://services
        variables: {}
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    batchInfo:
      title: batchInfo
      required:
      - id
      - jobId
      - state
      - createdDate
      - systemModstamp
      - numberRecordsProcessed
      - numberRecordsFailed
      - totalProcessingTime
      - apiActiveProcessingTime
      - apexProcessingTime
      type: object
      properties:
        id:
          type: string
          xml:
            name: id
            namespace: http://www.force.com/2009/06/asyncapi/dataload
            attribute: false
            wrapped: false
          example: abc123
        jobId:
          type: string
          xml:
            name: jobId
            namespace: http://www.force.com/2009/06/asyncapi/dataload
            attribute: false
            wrapped: false
          example: '500123'
        state:
          type: string
          xml:
            name: state
            namespace: http://www.force.com/2009/06/asyncapi/dataload
            attribute: false
            wrapped: false
          example: example_value
        createdDate:
          type: string
          xml:
            name: createdDate
            namespace: http://www.force.com/2009/06/asyncapi/dataload
            attribute: false
            wrapped: false
          example: example_value
        systemModstamp:
          type: string
          xml:
            name: systemModstamp
            namespace: http://www.force.com/2009/06/asyncapi/dataload
            attribute: false
            wrapped: false
          example: example_value
        numberRecordsProcessed:
          type: integer
          contentEncoding: int32
          xml:
            name: numberRecordsProcessed
            namespace: http://www.force.com/2009/06/asyncapi/dataload
            attribute: false
            wrapped: false
          example: 10
        numberRecordsFailed:
          type: integer
          contentEncoding: int32
          xml:
            name: numberRecordsFailed
            namespace: http://www.force.com/2009/06/asyncapi/dataload
            attribute: false
            wrapped: false
          example: 10
        totalProcessingTime:
          type: integer
          contentEncoding: int32
          xml:
            name: totalProcessingTime
            namespace: http://www.force.com/2009/06/asyncapi/dataload
            attribute: false
            wrapped: false
          example: 1700000000000
        apiActiveProcessingTime:
          type: integer
          contentEncoding: int32
          xml:
            name: apiActiveProcessingTime
            namespace: http://www.force.com/2009/06/asyncapi/dataload
            attribute: false
            wrapped: false
          example: 1700000000000
        apexProcessingTime:
          type: integer
          contentEncoding: int32
          xml:
            name: apexProcessingTime
            namespace: http://www.force.com/2009/06/asyncapi/dataload
            attribute: false
            wrapped: false
          example: 1700000000000
      xml:
        name: batchInfo
        namespace: http://www.force.com/2009/06/asyncapi/dataload
        attribute: false
        wrapped: false
    Getteststatus:
      title: Getteststatus
      required:
      - startTime
      - status
      type: object
      properties:
        startTime:
          type: string
          example: '2026-01-15T10:30:00Z'
        status:
          type: string
          example: example_value
      examples:
      - startTime: '2025-09-10T13:46:14.000Z'
        status: IN_PROGRESS
    batchInfoList:
      title: batchInfoList
      required:
      - batchInfo
      type: object
      properties:
        batchInfo:
          allOf:
          - $ref: '#/components/schemas/batchInfo'
          - xml:
              name: batchInfo
              namespace: http://www.force.com/2009/06/asyncapi/dataload
              attribute: false
              wrapped: false
          example: example_value
      xml:
        name: batchInfoList
        namespace: http://www.force.com/2009/06/asyncapi/dataload
        attribute: false
        wrapped: false
  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}".

        '