Salesforce Procedure API

The Procedure API from Salesforce — 1 operation(s) for procedure.

Documentation

Specifications

Schemas & Data

OpenAPI Specification

salesforce-procedure-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Salesforce Bulk API 2.0 Abort Procedure 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: Procedure
paths:
  /apexrest/{NAMESPACE}/v1/integrationprocedure/{TYPE_SUBTYPE}:
    parameters: []
    get:
      tags:
      - Procedure
      summary: Salesforce Integration Procedure Invocation Using Get
      operationId: IntegrationProcedureInvocationUsingGET
      parameters:
      - name: NAMESPACE
        in: path
        description: 'The namespace: `omnistudio`, `vlocity_ins`, `vlocity_cmt`, or `vlocity_ps`'
        required: true
        schema:
          type: string
        example: example_value
      - name: TYPE_SUBTYPE
        in: path
        description: Type and SubType of the Integration Procedure separated by an underscore.
        required: true
        schema:
          type: string
        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
    post:
      tags:
      - Procedure
      summary: Salesforce Integration Procedure Invocation Using Post
      operationId: IntegrationProcedureInvocationUsingPOST
      parameters:
      - name: NAMESPACE
        in: path
        description: The namespace is `omnistudio`, `vlocity_ins`, `vlocity_cmt`, or `vlocity_ps`
        required: true
        schema:
          type: string
        example: example_value
      - name: TYPE_SUBTYPE
        in: path
        description: Type and SubType of the Integration Procedure separated by an underscore.
        required: true
        schema:
          type: string
        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
components:
  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}".

        '