Coveo Salesforce Organizations API

openapi: 3.0.1
info:
  title: Coveo Activity Activities Salesforce Organizations API
  description: API for Coveo Platform
  termsOfService: https://www.coveo.com/en/support/terms-agreements
  contact:
    name: Coveo
    url: https://connect.coveo.com/s/discussions
  version: 1.0.0
servers:
- url: https://platform.cloud.coveo.com
  description: Coveo public API endpoint
security:
- oauth2:
  - full
tags:
- name: Salesforce Organizations
paths:
  /rest/salesforce/schema/:
    delete:
      operationId: flushCache
      summary: Flushes the Cached Data for a Salesforce Organization
      tags:
      - Salesforce Organizations
      deprecated: false
      parameters:
      - name: instanceUri
        description: The instance URI of the Salesforce organization
        required: true
        in: query
        type: string
      - name: sessionId
        description: Deprecated, use the appropriate 'X-Salesforce-Session-ID' header instead
        required: true
        in: query
        type: string
      - name: version
        description: 'The schema version to use. Allowed values: ["0" (CloudV1), "1" (Legacy), "2" (Current)]'
        default: '2'
        required: false
        in: query
        type: string
      - name: presets
        description: 'The schema presets to apply. Allowed values: ["servicecloud", "knowledge", "content", "chatter"]'
        required: false
        in: query
        type: string
      - name: X-Salesforce-Session-ID
        description: The Salesforce session ID to use
        required: true
        in: header
        type: string
      responses:
        '200':
          description: No response
      security:
      - oauth2:
        - full
  /rest/salesforce/schema/objects:
    post:
      operationId: loadObjects
      summary: Loads the Object Data for a List of Salesforce Objects.
      tags:
      - Salesforce Organizations
      deprecated: false
      parameters:
      - name: body
        required: true
        in: body
        schema:
          $ref: '#/definitions/LoadObjectsParams'
      - name: instanceUri
        description: The instance URI of the Salesforce organization
        required: true
        in: query
        type: string
      - name: sessionId
        description: Deprecated, use the appropriate 'X-Salesforce-Session-ID' header instead
        required: true
        in: query
        type: string
      - name: version
        description: 'The schema version to use. Allowed values: ["0" (CloudV1), "1" (Legacy), "2" (Current)]'
        default: '2'
        required: false
        in: query
        type: string
      - name: presets
        description: 'The schema presets to apply. Allowed values: ["servicecloud", "knowledge", "content", "chatter"]'
        required: false
        in: query
        type: string
      - name: X-Salesforce-Session-ID
        description: The Salesforce session ID to use
        required: true
        in: header
        type: string
      responses:
        '200':
          description: OK
          schema:
            type: array
            items:
              $ref: '#/definitions/ObjectDescription'
      security:
      - oauth2:
        - full
  /rest/salesforce/schema/organization:
    get:
      operationId: loadOrganization
      summary: Loads the Organization Data for a Salesforce Organization.
      tags:
      - Salesforce Organizations
      deprecated: false
      parameters:
      - name: instanceUri
        description: The instance URI of the Salesforce organization
        required: true
        in: query
        type: string
      - name: sessionId
        description: Deprecated, use the appropriate 'X-Salesforce-Session-ID' header instead
        required: true
        in: query
        type: string
      - name: version
        description: 'The schema version to use. Allowed values: ["0" (CloudV1), "1" (Legacy), "2" (Current)]'
        default: '2'
        required: false
        in: query
        type: string
      - name: presets
        description: 'The schema presets to apply. Allowed values: ["servicecloud", "knowledge", "content", "chatter"]'
        required: false
        in: query
        type: string
      - name: X-Salesforce-Session-ID
        description: The Salesforce session ID to use
        required: true
        in: header
        type: string
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/OrganizationDescription'
      security:
      - oauth2:
        - full
components:
  securitySchemes:
    oauth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://platform.cloud.coveo.com/oauth/authorize
          tokenUrl: https://platform.cloud.coveo.com/oauth/token
          scopes:
            full: required
definitions:
  ObjectSummary:
    type: object
    properties:
      objectType:
        type: string
      label:
        type: string
      searchable:
        type: boolean
      queryable:
        type: boolean
      replicateable:
        type: boolean
      keyPrefix:
        type: string
      isCustomObject:
        type: boolean
      isKnowledgeObject:
        type: boolean
      hasCustomFileType:
        type: boolean
      shouldIndexByDefault:
        type: boolean
    required:
    - objectType
    - label
    - searchable
    - queryable
    - replicateable
    - isCustomObject
    - isKnowledgeObject
    - hasCustomFileType
    - shouldIndexByDefault
  LegacyFieldInformation:
    type: object
    properties:
      relationshipName:
        type: string
      relationshipNameField:
        type: string
      polymorphic:
        type: boolean
      referenceTypes:
        type: array
        items:
          type: string
    required:
    - relationshipName
    - relationshipNameField
    - polymorphic
    - referenceTypes
  OrganizationDescription:
    type: object
    properties:
      organizationId:
        type: string
      objects:
        type: array
        items:
          $ref: '#/definitions/ObjectSummary'
      knowledgeLanguages:
        type: array
        items:
          type: string
      dataCategoryGroups:
        type: array
        items:
          $ref: '#/definitions/DataCategoryGroupDescription'
    required:
    - organizationId
    - objects
    - knowledgeLanguages
    - dataCategoryGroups
  ObjectDescription:
    type: object
    properties:
      objectType:
        type: string
      fieldsByName:
        type: object
        additionalProperties:
          type: array
          items:
            $ref: '#/definitions/FieldDescription'
      fieldsByCoveoName:
        type: object
        additionalProperties:
          $ref: '#/definitions/FieldDescription'
      fieldsBySalesforceName:
        type: object
        additionalProperties:
          type: array
          items:
            $ref: '#/definitions/FieldDescription'
      relationshipsByName:
        type: object
        additionalProperties:
          $ref: '#/definitions/RelationshipDescription'
      label:
        type: string
      searchable:
        type: boolean
      queryable:
        type: boolean
      replicateable:
        type: boolean
      keyPrefix:
        type: string
      isCustomObject:
        type: boolean
      isKnowledgeObject:
        type: boolean
      hasCustomFileType:
        type: boolean
      shouldIndexByDefault:
        type: boolean
      titleFields:
        type: array
        items:
          type: string
      fields:
        type: array
        items:
          $ref: '#/definitions/FieldDescription'
      relationships:
        type: array
        items:
          $ref: '#/definitions/RelationshipDescription'
    required:
    - objectType
    - label
    - searchable
    - queryable
    - replicateable
    - isCustomObject
    - isKnowledgeObject
    - hasCustomFileType
    - shouldIndexByDefault
    - titleFields
    - fields
    - relationships
    - fieldsByName
    - fieldsByCoveoName
    - fieldsBySalesforceName
    - relationshipsByName
  FieldDescription:
    type: object
    properties:
      name:
        type: string
      coveoName:
        type: string
      salesforceName:
        type: string
      label:
        type: string
      kind:
        type: string
      custom:
        type: boolean
      virtual:
        type: boolean
      retrievable:
        type: boolean
      filterable:
        type: boolean
      sortable:
        type: boolean
      multiValue:
        type: boolean
      mandatory:
        type: boolean
      shouldIndexByDefault:
        type: boolean
      dataCategoryGroup:
        type: string
      mapping:
        $ref: '#/definitions/MappingDescription'
      legacyFieldInformation:
        $ref: '#/definitions/LegacyFieldInformation'
    required:
    - name
    - coveoName
    - salesforceName
    - label
    - kind
    - custom
    - virtual
    - retrievable
    - filterable
    - sortable
    - multiValue
    - mandatory
    - shouldIndexByDefault
  LoadObjectsParams:
    type: object
    properties:
      names:
        description: The object names to load.
        type: array
        items:
          type: string
    required:
    - names
  DataCategoryGroupDescription:
    type: object
    properties:
      name:
        type: string
      values:
        type: array
        items:
          $ref: '#/definitions/DataCategoryValueDescription'
    required:
    - name
    - values
  DataCategoryValueDescription:
    type: object
    properties:
      name:
        type: string
      label:
        type: string
    required:
    - name
    - label
  MappingDescription:
    type: object
    properties:
      extractionMethod:
        type: string
      content:
        type: string
      fieldTypeHint:
        type: string
    required:
    - extractionMethod
    - content
  RelationshipDescription:
    type: object
    properties: {}