Salesforce Automation

opencollection: 1.0.0
info:
  name: Salesforce Tooling API
  version: '63.0'
request:
  auth:
    type: oauth2
    flow: authorization_code
    authorizationUrl: https://login.salesforce.com/services/oauth2/authorize
    accessTokenUrl: https://login.salesforce.com/services/oauth2/token
    credentials:
      clientId: '{{clientId}}'
      clientSecret: '{{clientSecret}}'
items:
- info:
    name: SObjects
    type: folder
  items:
  - info:
      name: List all Tooling API objects
      type: http
    http:
      method: GET
      url: https://{instance}.salesforce.com/services/data/v63.0/tooling/sobjects
    docs: Returns a list of all objects available through the Tooling API, including metadata types like ApexClass, ApexTrigger,
      Flow, FlowDefinition, CustomField, and more.
  - info:
      name: Describe a Tooling API object
      type: http
    http:
      method: GET
      url: https://{instance}.salesforce.com/services/data/v63.0/tooling/sobjects/:sObjectName
      params:
      - name: sObjectName
        value: ''
        type: path
        description: The API name of the Tooling API object (e.g., ApexClass, ApexTrigger, Flow, FlowDefinition)
    docs: Returns metadata for a specific Tooling API object type including fields, relationships, and capabilities.
- info:
    name: Records
    type: folder
  items:
  - info:
      name: Create a Tooling API record
      type: http
    http:
      method: POST
      url: https://{instance}.salesforce.com/services/data/v63.0/tooling/sobjects/:sObjectName
      params:
      - name: sObjectName
        value: ''
        type: path
        description: The API name of the Tooling API object (e.g., ApexClass, ApexTrigger, Flow, FlowDefinition)
      body:
        type: json
        data: '{}'
    docs: Creates a new record of the specified Tooling API object type (e.g., ApexClass, ApexTrigger, TraceFlag).
  - info:
      name: Get a Tooling API record
      type: http
    http:
      method: GET
      url: https://{instance}.salesforce.com/services/data/v63.0/tooling/sobjects/:sObjectName/:recordId
      params:
      - name: sObjectName
        value: ''
        type: path
        description: The API name of the Tooling API object (e.g., ApexClass, ApexTrigger, Flow, FlowDefinition)
      - name: recordId
        value: ''
        type: path
        description: The 18-character record ID
    docs: Retrieves a specific Tooling API record by ID.
  - info:
      name: Update a Tooling API record
      type: http
    http:
      method: PATCH
      url: https://{instance}.salesforce.com/services/data/v63.0/tooling/sobjects/:sObjectName/:recordId
      params:
      - name: sObjectName
        value: ''
        type: path
        description: The API name of the Tooling API object (e.g., ApexClass, ApexTrigger, Flow, FlowDefinition)
      - name: recordId
        value: ''
        type: path
        description: The 18-character record ID
      body:
        type: json
        data: '{}'
    docs: Updates fields on a specific Tooling API record.
  - info:
      name: Delete a Tooling API record
      type: http
    http:
      method: DELETE
      url: https://{instance}.salesforce.com/services/data/v63.0/tooling/sobjects/:sObjectName/:recordId
      params:
      - name: sObjectName
        value: ''
        type: path
        description: The API name of the Tooling API object (e.g., ApexClass, ApexTrigger, Flow, FlowDefinition)
      - name: recordId
        value: ''
        type: path
        description: The 18-character record ID
    docs: Deletes a specific Tooling API record.
- info:
    name: Flows
    type: folder
  items:
  - info:
      name: Get a Flow definition
      type: http
    http:
      method: GET
      url: https://{instance}.salesforce.com/services/data/v63.0/tooling/sobjects/Flow/:flowId
      params:
      - name: flowId
        value: ''
        type: path
        description: The 18-character ID of the Flow version record
    docs: Retrieves metadata for a specific Salesforce Flow, including its version, status, process type, and associated metadata.
      Flows are the primary automation mechanism in Salesforce.
  - info:
      name: Get a Flow definition metadata
      type: http
    http:
      method: GET
      url: https://{instance}.salesforce.com/services/data/v63.0/tooling/sobjects/FlowDefinition/:flowDefinitionId
      params:
      - name: flowDefinitionId
        value: ''
        type: path
        description: The 18-character ID of the FlowDefinition record
    docs: Retrieves the FlowDefinition record, which represents the overall Flow independent of version. Contains the active
      version number and the developer name.
  - info:
      name: Activate or deactivate a Flow version
      type: http
    http:
      method: PATCH
      url: https://{instance}.salesforce.com/services/data/v63.0/tooling/sobjects/FlowDefinition/:flowDefinitionId
      params:
      - name: flowDefinitionId
        value: ''
        type: path
      body:
        type: json
        data: '{}'
    docs: Updates the FlowDefinition to activate a specific flow version by setting the ActiveVersionNumber, or deactivates
      by setting it to null.
- info:
    name: Query
    type: folder
  items:
  - info:
      name: Execute a Tooling API SOQL query
      type: http
    http:
      method: GET
      url: https://{instance}.salesforce.com/services/data/v63.0/tooling/query
      params:
      - name: q
        value: ''
        type: query
        description: The SOQL query string targeting Tooling API objects (e.g., SELECT Id, FullName, Metadata FROM Flow WHERE
          Status = 'Active')
    docs: Executes a SOQL query against Tooling API objects. Supports querying ApexClass, ApexTrigger, Flow, FlowDefinition,
      CustomField, ValidationRule, WorkflowRule, and other metadata types.
- info:
    name: Testing
    type: folder
  items:
  - info:
      name: Run Apex tests asynchronously
      type: http
    http:
      method: POST
      url: https://{instance}.salesforce.com/services/data/v63.0/tooling/runTestsAsynchronous
      body:
        type: json
        data: '{}'
    docs: Submits a set of Apex test classes or methods for asynchronous execution. Returns a test run ID that can be used
      to check status.
  - info:
      name: Run Apex tests synchronously
      type: http
    http:
      method: POST
      url: https://{instance}.salesforce.com/services/data/v63.0/tooling/runTestsSynchronous
      body:
        type: json
        data: '{}'
    docs: Runs a set of Apex test classes synchronously and returns the results immediately. Best for small test runs; use
      the asynchronous endpoint for larger test suites.
- info:
    name: Development
    type: folder
  items:
  - info:
      name: Get code completions
      type: http
    http:
      method: GET
      url: https://{instance}.salesforce.com/services/data/v63.0/tooling/completions
      params:
      - name: type
        value: ''
        type: query
        description: The type of completion (apex)
    docs: Returns code completion suggestions for Apex code in a specific class or trigger at a given position.
bundled: true