Salesforce Relay API

openapi: 3.1.0
info:
  title: Salesforce Bulk API 2.0 Abort Relay 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: Relay
paths:
  /data/v64.0/tooling/sobjects/EventRelayConfig/describe:
    parameters: []
    get:
      tags:
      - Relay
      summary: Salesforce Describe Event Relay
      operationId: Describeeventrelay
      parameters: []
      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/tooling/sobjects/EventRelayConfig:
    parameters: []
    post:
      tags:
      - Relay
      summary: Salesforce Create Event Relay
      operationId: Createeventrelay
      parameters: []
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/CreateeventrelayRequest'
              - examples:
                - FullName: MyEventRelay
                  Metadata:
                    eventChannel: Carbon_Comparison_Channel__chn
                    destinationResourceName: callout:MyNamedCredential
                    label: My Event Relay
                    relayOption: '{"ReplayRecovery":"LATEST"}'
              contentMediaType: application/json
            example:
              FullName: MyEventRelay
              Metadata:
                eventChannel: Carbon_Comparison_Channel__chn
                destinationResourceName: callout:MyNamedCredential
                label: My Event Relay
                relayOption: '{"ReplayRecovery":"LATEST"}'
        required: true
      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/tooling/sobjects/EventRelayConfig/{EVENT_RELAY_CONFIG_ID}:
    parameters: []
    delete:
      tags:
      - Relay
      summary: Salesforce Delete Event Relay
      operationId: Deleteeventrelay
      parameters:
      - name: EVENT_RELAY_CONFIG_ID
        in: path
        description: ''
        required: true
        schema:
          type: string
          examples:
          - 'null'
        example: '500123'
      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
    get:
      tags:
      - Relay
      summary: Salesforce Get Event Relay
      operationId: Geteventrelay
      parameters:
      - name: EVENT_RELAY_CONFIG_ID
        in: path
        description: ''
        required: true
        schema:
          type: string
          examples:
          - 7k2RM000000008ZYAQ
        example: '500123'
      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
    patch:
      tags:
      - Relay
      summary: Salesforce Change Event Relay State
      operationId: Changeeventrelaystate
      parameters:
      - name: EVENT_RELAY_CONFIG_ID
        in: path
        description: ''
        required: true
        schema:
          type: string
        example: '500123'
      - name: SOAPAction
        in: header
        description: ''
        required: true
        schema:
          type: string
          examples:
          - '""'
        example: example_value
      - name: Authorization
        in: header
        description: ''
        required: true
        schema:
          type: string
          examples:
          - 'Bearer '
        example: example_value
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/ChangeeventrelaystateRequest'
              - examples:
                - Metadata:
                    state: RUN
              contentMediaType: application/json
            example:
              Metadata:
                state: RUN
        required: true
      responses:
        '200':
          description: ''
          headers: {}
      deprecated: false
      security: []
      servers:
      - url: https://services
        variables: {}
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /data/v64.0/query:
    parameters: []
    get:
      tags:
      - Relay
      summary: Salesforce List Event Relay Feedback Items
      operationId: Listeventrelayfeedbackitems
      parameters:
      - name: q
        in: query
        description: ''
        required: true
        style: form
        explode: true
        schema:
          type: string
          examples:
          - SELECT FIELDS(ALL) FROM EventRelayFeedback LIMIT 200
        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/EventRelayFeedback/{EVENT_RELAY_FEEDBACK_ID}:
    parameters: []
    get:
      tags:
      - Relay
      summary: Salesforce Get Event Relay Feedback
      operationId: Geteventrelayfeedback
      parameters:
      - name: EVENT_RELAY_FEEDBACK_ID
        in: path
        description: ''
        required: true
        schema:
          type: string
          examples:
          - 7k4RM000000008AYAQ
        example: '500123'
      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
components:
  schemas:
    ChangeeventrelaystateRequest:
      title: ChangeeventrelaystateRequest
      required:
      - Metadata
      type: object
      properties:
        Metadata:
          $ref: '#/components/schemas/Metadata13'
      examples:
      - Metadata:
          state: RUN
    Metadata13:
      title: Metadata13
      required:
      - state
      type: object
      properties:
        state:
          type: string
          example: example_value
      examples:
      - state: RUN
    CreateeventrelayRequest:
      title: CreateeventrelayRequest
      required:
      - FullName
      - Metadata
      type: object
      properties:
        FullName:
          type: string
          example: example_value
        Metadata:
          $ref: '#/components/schemas/Metadata12'
      examples:
      - FullName: MyEventRelay
        Metadata:
          eventChannel: Carbon_Comparison_Channel__chn
          destinationResourceName: callout:MyNamedCredential
          label: My Event Relay
          relayOption: '{"ReplayRecovery":"LATEST"}'
    Metadata12:
      title: Metadata12
      required:
      - eventChannel
      - destinationResourceName
      - label
      - relayOption
      type: object
      properties:
        eventChannel:
          type: string
          example: example_value
        destinationResourceName:
          type: string
          example: example_value
        label:
          type: string
          example: Example Title
        relayOption:
          type: string
          example: example_value
      examples:
      - eventChannel: Carbon_Comparison_Channel__chn
        destinationResourceName: callout:MyNamedCredential
        label: My Event Relay
        relayOption: '{"ReplayRecovery":"LATEST"}'
  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}".

        '