Salesforce Platform API

openapi: 3.1.0
info:
  title: Salesforce Bulk API 2.0 Abort Platform 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: Platform
paths:
  /data/v64.0/event/eventSchema/{SCHEMA_ID}:
    parameters: []
    get:
      tags:
      - Platform
      summary: Salesforce Platform Event Schema by Schema Id
      description: Set, reset, or get information about a user password. This resource is available in REST API version 24.0 and later.
      operationId: PlatformEventSchemabySchemaID
      parameters:
      - name: SCHEMA_ID
        in: path
        description: ''
        required: true
        schema:
          type: string
        example: '500123'
      - name: Content-Type
        in: header
        description: ''
        required: true
        schema:
          const: application/json
          type: string
          examples:
          - application/json
        example: example_value
      responses:
        '200':
          description: ''
          headers: {}
      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/sobjects/{EVENT_NAME}/eventSchema:
    parameters: []
    get:
      tags:
      - Platform
      summary: Salesforce Platform Event Schema by Event Name
      description: Set, reset, or get information about a user password. This resource is available in REST API version 24.0 and later.
      operationId: PlatformEventSchemabyEventName
      parameters:
      - name: EVENT_NAME
        in: path
        description: API Name of the event
        required: true
        schema:
          type: string
        example: example_value
      - name: Content-Type
        in: header
        description: ''
        required: true
        schema:
          const: application/json
          type: string
          examples:
          - application/json
        example: example_value
      responses:
        '200':
          description: OK
          headers:
            Date:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: Mon, 03 Jul 2023 13:06:08 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-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
            Sforce-Limit-Info:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: api-usage=2/15000
            Vary:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: Accept-Encoding
            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/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/PlatformEventSchemabyEventName'
              examples:
                Platformeventschemabyeventname200Example:
                  summary: Default PlatformEventSchemabyEventName 200 response
                  x-microcks-default: true
                  value:
                    name: Example Title
                    namespace: example_value
                    type: example_value
                    fields:
                    - name: Example Title
                      type: example_value
      deprecated: false
      servers:
      - url: https://services
        variables: {}
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    Type:
      title: Type
      type: object
      properties:
        type:
          type: string
          example: example_value
        name:
          type: string
          example: Example Title
        namespace:
          type: string
          example: example_value
        fields:
          type: array
          items:
            $ref: '#/components/schemas/Field3'
          description: ''
          example: []
    Field3:
      title: Field3
      required:
      - name
      - type
      type: object
      properties:
        name:
          type: string
          example: Example Title
        type:
          oneOf:
          - $ref: '#/components/schemas/Type1'
          - $ref: '#/components/schemas/Type11'
          example: example_value
    Field2:
      title: Field2
      required:
      - name
      - type
      type: object
      properties:
        name:
          type: string
          example: Example Title
        type:
          oneOf:
          - $ref: '#/components/schemas/Type'
          - type: string
          example: example_value
    Type1:
      title: Type1
      type: object
      properties:
        type:
          type: string
          example: example_value
        name:
          type: string
          example: Example Title
        doc:
          type: string
          example: example_value
        fields:
          type: array
          items:
            $ref: '#/components/schemas/Field4'
          description: ''
          example: []
    PlatformEventSchemabyEventName:
      title: PlatformEventSchemabyEventName
      required:
      - name
      - namespace
      - type
      - fields
      type: object
      properties:
        name:
          type: string
          example: Example Title
        namespace:
          type: string
          example: example_value
        type:
          type: string
          example: example_value
        fields:
          type: array
          items:
            $ref: '#/components/schemas/Field2'
          description: ''
          example: []
    Field4:
      title: Field4
      required:
      - name
      - type
      - doc
      type: object
      properties:
        name:
          type: string
          example: Example Title
        type:
          oneOf:
          - type: array
            items:
              type: string
          - type: array
            items:
              type: string
          example: example_value
        doc:
          type: string
          example: example_value
        default:
          type:
          - string
          - 'null'
          example: example_value
    Type11:
      title: Type11
      required:
      - type
      - name
      - doc
      - fields
      type: object
      properties:
        type:
          type: string
          example: example_value
        name:
          type: string
          example: Example Title
        doc:
          type: string
          example: example_value
        fields:
          type: array
          items:
            $ref: '#/components/schemas/Field5'
          description: ''
          example: []
    Field5:
      title: Field5
      required:
      - name
      - type
      type: object
      properties:
        name:
          type: string
          example: Example Title
        type:
          oneOf:
          - type: array
            items:
              type: string
          - type: array
            items:
              type: string
          example: example_value
        doc:
          type: string
          example: example_value
        default:
          type:
          - string
          - 'null'
          example: example_value
  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}".

        '