openapi: 3.1.0
info:
  title: Salesforce Analytics (CRM Analytics) REST Actions SObject Collections API
  description: REST API for accessing and managing CRM Analytics (formerly Tableau CRM / Einstein Analytics) resources including datasets, lenses, dashboards, and dataflows. Enables programmatic access to analytics metadata, query execution, and dashboard management. Uses the Wave API resource at /services/data/vXX.0/wave.
  version: '63.0'
  contact:
    name: Salesforce Developer Support
    url: https://developer.salesforce.com/support
    email: developer@salesforce.com
  license:
    name: Salesforce API Terms of Use
    url: https://www.salesforce.com/company/legal/agreements/
servers:
- url: https://{instance}.salesforce.com/services/data/v63.0/wave
  description: Salesforce production or developer instance
  variables:
    instance:
      default: yourInstance
      description: Your Salesforce instance identifier
security:
- oauth2: []
- bearerAuth: []
tags:
- name: SObject Collections
  description: Bulk CRUD operations on up to 200 records
paths:
  /composite/sobjects:
    post:
      operationId: createMultipleRecords
      summary: Create multiple records of the same type
      description: Creates up to 200 records of the same SObject type in a single request. More efficient than individual create calls for bulk record creation.
      tags:
      - SObject Collections
      parameters:
      - $ref: '#/components/parameters/allOrNone'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SObjectCollectionCreateRequest'
      responses:
        '200':
          description: Array of save results
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SaveResult'
    patch:
      operationId: updateMultipleRecords
      summary: Update multiple records
      description: Updates up to 200 records in a single request. Records can be of different SObject types. Each record must include the Id field and the attributes.type field.
      tags:
      - SObject Collections
      parameters:
      - $ref: '#/components/parameters/allOrNone'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SObjectCollectionUpdateRequest'
      responses:
        '200':
          description: Array of save results
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SaveResult'
    delete:
      operationId: deleteMultipleRecords
      summary: Delete multiple records
      description: Deletes up to 200 records in a single request. Provide record IDs as a comma-separated query parameter.
      tags:
      - SObject Collections
      parameters:
      - name: ids
        in: query
        required: true
        description: Comma-separated list of record IDs to delete (up to 200)
        schema:
          type: string
      - $ref: '#/components/parameters/allOrNone'
      responses:
        '200':
          description: Array of delete results
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SaveResult'
  /composite/sobjects/{sObjectName}:
    get:
      operationId: getMultipleRecords
      summary: Get multiple records by IDs
      description: Retrieves multiple records of the same SObject type by their IDs in a single request.
      tags:
      - SObject Collections
      parameters:
      - name: sObjectName
        in: path
        required: true
        schema:
          type: string
      - name: ids
        in: query
        required: true
        description: Comma-separated list of record IDs
        schema:
          type: string
      - name: fields
        in: query
        required: true
        description: Comma-separated list of field API names to return
        schema:
          type: string
      responses:
        '200':
          description: Array of records
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  additionalProperties: true
components:
  schemas:
    SObjectCollectionCreateRequest:
      type: object
      required:
      - records
      properties:
        allOrNone:
          type: boolean
          default: false
        records:
          type: array
          maxItems: 200
          items:
            type: object
            required:
            - attributes
            properties:
              attributes:
                type: object
                required:
                - type
                properties:
                  type:
                    type: string
            additionalProperties: true
    SObjectCollectionUpdateRequest:
      type: object
      required:
      - records
      properties:
        allOrNone:
          type: boolean
          default: false
        records:
          type: array
          maxItems: 200
          items:
            type: object
            required:
            - attributes
            - Id
            properties:
              attributes:
                type: object
                required:
                - type
                properties:
                  type:
                    type: string
              Id:
                type: string
            additionalProperties: true
    SaveResult:
      type: object
      properties:
        id:
          type: string
        success:
          type: boolean
        errors:
          type: array
          items:
            type: object
            properties:
              statusCode:
                type: string
              message:
                type: string
              fields:
                type: array
                items:
                  type: string
  parameters:
    allOrNone:
      name: allOrNone
      in: query
      description: If true, all records in the request must succeed or all are rolled back
      schema:
        type: boolean
        default: false
  securitySchemes:
    oauth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://login.salesforce.com/services/oauth2/authorize
          tokenUrl: https://login.salesforce.com/services/oauth2/token
          scopes:
            api: Access and manage your Salesforce data
            wave_api: Access CRM Analytics REST API resources
    bearerAuth:
      type: http
      scheme: bearer