Salesforce Sales Cloud Salesforce User Interface API — Records

naftiko: 1.0.0-alpha2
info:
  label: Salesforce Sales Cloud Salesforce User Interface API — Records
  description: 'Salesforce Sales Cloud Salesforce User Interface API — Records. 4 operations. Lead operation: Salesforce Sales
    Cloud Create a record. Self-contained Naftiko capability covering one Salesforce Sales Cloud business surface.'
  tags:
  - Salesforce Sales Cloud
  - Records
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    SALESFORCE_SALES_CLOUD_API_KEY: SALESFORCE_SALES_CLOUD_API_KEY
capability:
  consumes:
  - type: http
    namespace: ui-records
    baseUri: https://{instance}.salesforce.com/services/data/v59.0/ui-api
    description: Salesforce Sales Cloud Salesforce User Interface API — Records business capability. Self-contained, no shared
      references.
    resources:
    - name: records
      path: /records
      operations:
      - name: createrecord
        method: POST
        description: Salesforce Sales Cloud Create a record
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: records-recordId
      path: /records/{recordId}
      operations:
      - name: getrecord
        method: GET
        description: Salesforce Sales Cloud Get a record with UI metadata
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: fields
          in: query
          type: string
          description: Comma-separated list of field API names to return
        - name: layoutTypes
          in: query
          type: string
          description: Layout type to determine which fields to return
        - name: modes
          in: query
          type: string
          description: The mode for the layout
        - name: optionalFields
          in: query
          type: string
          description: Optional fields returned if accessible
      - name: updaterecord
        method: PATCH
        description: Salesforce Sales Cloud Update a record
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deleterecord
        method: DELETE
        description: Salesforce Sales Cloud Delete a record
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: bearer
      token: '{{env.SALESFORCE_SALES_CLOUD_API_KEY}}'
  exposes:
  - type: rest
    namespace: ui-records-rest
    port: 8080
    description: REST adapter for Salesforce Sales Cloud Salesforce User Interface API — Records. One Spectral-compliant resource
      per consumed operation, prefixed with /v1.
    resources:
    - path: /v1/records
      name: records
      description: REST surface for records.
      operations:
      - method: POST
        name: createrecord
        description: Salesforce Sales Cloud Create a record
        call: ui-records.createrecord
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/records/{recordid}
      name: records-recordid
      description: REST surface for records-recordId.
      operations:
      - method: GET
        name: getrecord
        description: Salesforce Sales Cloud Get a record with UI metadata
        call: ui-records.getrecord
        with:
          fields: rest.fields
          layoutTypes: rest.layoutTypes
          modes: rest.modes
          optionalFields: rest.optionalFields
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: updaterecord
        description: Salesforce Sales Cloud Update a record
        call: ui-records.updaterecord
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleterecord
        description: Salesforce Sales Cloud Delete a record
        call: ui-records.deleterecord
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: ui-records-mcp
    port: 9090
    transport: http
    description: MCP adapter for Salesforce Sales Cloud Salesforce User Interface API — Records. One tool per consumed operation,
      routed inline through this capability's consumes block.
    tools:
    - name: salesforce-sales-cloud-create-record
      description: Salesforce Sales Cloud Create a record
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: ui-records.createrecord
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: salesforce-sales-cloud-get-record
      description: Salesforce Sales Cloud Get a record with UI metadata
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: ui-records.getrecord
      with:
        fields: tools.fields
        layoutTypes: tools.layoutTypes
        modes: tools.modes
        optionalFields: tools.optionalFields
      outputParameters:
      - type: object
        mapping: $.
    - name: salesforce-sales-cloud-update-record
      description: Salesforce Sales Cloud Update a record
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: ui-records.updaterecord
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: salesforce-sales-cloud-delete-record
      description: Salesforce Sales Cloud Delete a record
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: ui-records.deleterecord
      outputParameters:
      - type: object
        mapping: $.