Salesforce REST API — SOQL

naftiko: 1.0.0-alpha2
info:
  label: Salesforce REST API — SOQL
  description: 'Salesforce REST API — SOQL. 3 operations. Lead operation: Execute a SOQL query. Self-contained Naftiko capability
    covering one Salesforce Automation business surface.'
  tags:
  - Salesforce Automation
  - SOQL
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    SALESFORCE_AUTOMATION_API_KEY: SALESFORCE_AUTOMATION_API_KEY
capability:
  consumes:
  - type: http
    namespace: salesforce-rest-soql
    baseUri: https://{instance}.salesforce.com/services/data/v63.0
    description: Salesforce REST API — SOQL business capability. Self-contained, no shared references.
    resources:
    - name: query
      path: /query
      operations:
      - name: query
        method: GET
        description: Execute a SOQL query
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: q
          in: query
          type: string
          description: The SOQL query string (e.g., SELECT Id, Name FROM Account WHERE Industry = 'Technology')
          required: true
    - name: query-queryLocator
      path: /query/{queryLocator}
      operations:
      - name: querymore
        method: GET
        description: Retrieve additional query results
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: queryLocator
          in: path
          type: string
          description: The query locator from the nextRecordsUrl of a previous query response
          required: true
    - name: queryAll
      path: /queryAll
      operations:
      - name: queryall
        method: GET
        description: Execute a SOQL query including deleted and archived records
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: q
          in: query
          type: string
          description: The SOQL query string
          required: true
    authentication:
      type: bearer
      token: '{{env.SALESFORCE_AUTOMATION_API_KEY}}'
  exposes:
  - type: rest
    namespace: salesforce-rest-soql-rest
    port: 8080
    description: REST adapter for Salesforce REST API — SOQL. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/query
      name: query
      description: REST surface for query.
      operations:
      - method: GET
        name: query
        description: Execute a SOQL query
        call: salesforce-rest-soql.query
        with:
          q: rest.q
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/query/{querylocator}
      name: query-querylocator
      description: REST surface for query-queryLocator.
      operations:
      - method: GET
        name: querymore
        description: Retrieve additional query results
        call: salesforce-rest-soql.querymore
        with:
          queryLocator: rest.queryLocator
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/queryall
      name: queryall
      description: REST surface for queryAll.
      operations:
      - method: GET
        name: queryall
        description: Execute a SOQL query including deleted and archived records
        call: salesforce-rest-soql.queryall
        with:
          q: rest.q
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: salesforce-rest-soql-mcp
    port: 9090
    transport: http
    description: MCP adapter for Salesforce REST API — SOQL. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: execute-soql-query
      description: Execute a SOQL query
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: salesforce-rest-soql.query
      with:
        q: tools.q
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieve-additional-query-results
      description: Retrieve additional query results
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: salesforce-rest-soql.querymore
      with:
        queryLocator: tools.queryLocator
      outputParameters:
      - type: object
        mapping: $.
    - name: execute-soql-query-including-deleted
      description: Execute a SOQL query including deleted and archived records
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: salesforce-rest-soql.queryall
      with:
        q: tools.q
      outputParameters:
      - type: object
        mapping: $.