openapi: 3.0.1
info:
title: Coveo Source 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: Sources
description: Operations specific to source schedules
- name: Sources
description: Operations specific to fields in sources
paths:
/rest/organizations/{organizationId}/sources/{sourceId}:
get:
tags:
- Sources
summary: Get a Single Source
description: 'Privilege required
```
{"owner":"PLATFORM","targetDomain":"SOURCE","type":"VIEW","targetId":"*"}
```
Privilege required
```
{"owner":"PLATFORM","targetDomain":"SOURCE","type":"EDIT","targetId":"{sourceId}"}
```
Privilege required
```
{"owner":"PLATFORM","targetDomain":"SOURCE","type":"EDIT","targetId":"{sourceId}"}
```
Privilege required
```
{"owner":"PLATFORM","targetDomain":"SOURCE","type":"VIEW","targetId":"*"}
```
Privilege required
```
{"owner":"PLATFORM","targetDomain":"SOURCE","type":"EDIT","targetId":"{sourceId}"}
```
Privilege required
```
{"owner":"PLATFORM","targetDomain":"SOURCE","type":"EDIT","targetId":"{sourceId}"}
```
Privilege required
```
{"owner":"PLATFORM","targetDomain":"SOURCE","type":"VIEW","targetId":"*"}
```
Privilege required
```
{"owner":"PLATFORM","targetDomain":"SOURCE","type":"EDIT","targetId":"{sourceId}"}
```
Privilege required
```
{"owner":"PLATFORM","targetDomain":"SOURCE","type":"EDIT","targetId":"{sourceId}"}
```
See [Managing the Mapping Configuration of a Source](https://docs.coveo.com/en/29/).**Required privilege:**
Sources - View
Privilege required
```
{"owner":"PLATFORM","targetDomain":"SOURCE","type":"VIEW","targetId":"*"}
```
**Example:**
`mycoveocloudv2organizationg8tp8wu3`
required: true
schema:
type: string
- name: sourceId
in: path
description: The unique identifier of the target [source](https://docs.coveo.com/en/246/).
**Example:** `mycoveocloudv2organizationg8tp8wu3-gravodalyysjsu34camnvxm2d2y`
required: true
schema:
type: string
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/MappingsConfigurationModel'
x-pretty-name: getMappingsConfiguration
x-required-privilege:
owner: PLATFORM
targetDomain: SOURCE
type: VIEW
targetId: '*'
x-required-privileges:
- owner: PLATFORM
targetDomain: SOURCE
type: VIEW
targetId: '*'
x-ui-operation-id: /rest/organizations/paramId/sources/paramId/mappings_get
put:
tags:
- Mappings
summary: Update Mapping Configuration
description: 'Updates the [mapping](https://docs.coveo.com/en/217/) configuration of a [source](https://docs.coveo.com/en/246/).
See [Managing the Mapping Configuration of a Source](https://docs.coveo.com/en/29/).**Required privilege:**
Sources - Edit
Privilege required
```
{"owner":"PLATFORM","targetDomain":"SOURCE","type":"EDIT","targetId":"{sourceId}"}
```
**Example:**
`mycoveocloudv2organizationg8tp8wu3`
required: true
schema:
type: string
- name: sourceId
in: path
description: The unique identifier of the target [source](https://docs.coveo.com/en/246/).
**Example:** `mycoveocloudv2organizationg8tp8wu3-gravodalyysjsu34camnvxm2d2y`
required: true
schema:
type: string
- name: rebuild
in: query
description: Whether to rebuild the [source](https://docs.coveo.com/en/246/) after the operation.
**Default:**
`false`
required: false
schema:
type: boolean
default: false
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/MappingsConfigurationModel'
required: true
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/MappingsConfigurationModel'
x-pretty-name: updateMappingsConfiguration
x-required-privilege:
owner: PLATFORM
targetDomain: SOURCE
type: EDIT
targetId: '{sourceId}'
x-required-privileges:
- owner: PLATFORM
targetDomain: SOURCE
type: EDIT
targetId: '{sourceId}'
x-ui-operation-id: /rest/organizations/paramId/sources/paramId/mappings_put
/rest/organizations/{organizationId}/sources/{sourceId}/mappings/types/{typeId}:
get:
tags:
- Mappings
summary: List Specific Mappings of Given Type
description: 'Lists the [mappings](https://docs.coveo.com/en/217/) of a specific [item](https://docs.coveo.com/en/210/)
type.**Required privilege:** Sources - View
Privilege required
```
{"owner":"PLATFORM","targetDomain":"SOURCE","type":"VIEW","targetId":"*"}
```
**Example:**
`mycoveocloudv2organizationg8tp8wu3`
required: true
schema:
type: string
- name: sourceId
in: path
description: The unique identifier of the target [source](https://docs.coveo.com/en/246/).
**Example:** `mycoveocloudv2organizationg8tp8wu3-gravodalyysjsu34camnvxm2d2y`
required: true
schema:
type: string
- name: typeId
in: path
description: The specific [mapping](https://docs.coveo.com/en/217/) type to show.
**Example:** `Video`
required: true
schema:
type: string
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/TypedMappingSettingsModel'
x-pretty-name: getMappingTypeSettings
x-required-privilege:
owner: PLATFORM
targetDomain: SOURCE
type: VIEW
targetId: '*'
x-required-privileges:
- owner: PLATFORM
targetDomain: SOURCE
type: VIEW
targetId: '*'
x-ui-operation-id: /rest/organizations/paramId/sources/paramId/mappings/types/paramId_get
put:
tags:
- Mappings
summary: Update Specific Mappings of Given Type
description: 'Updates the [mappings](https://docs.coveo.com/en/217/) of a specific [item](https://docs.coveo.com/en/210/)
type.**Required privilege:** Sources - Edit
Privilege required
```
{"owner":"PLATFORM","targetDomain":"SOURCE","type":"EDIT","targetId":"{sourceId}"}
```
**Example:**
`mycoveocloudv2organizationg8tp8wu3`
required: true
schema:
type: string
- name: sourceId
in: path
description: The unique identifier of the target [source](https://docs.coveo.com/en/246/).
**Example:** `mycoveocloudv2organizationg8tp8wu3-gravodalyysjsu34camnvxm2d2y`
required: true
schema:
type: string
- name: typeId
in: path
description: The specific [mapping](https://docs.coveo.com/en/217/) type to update.
**Example:** `Video`
required: true
schema:
type: string
- name: rebuild
in: query
description: Whether to rebuild the [source](https://docs.coveo.com/en/246/) after the operation.
**Default:**
`false`
required: false
schema:
type: boolean
default: false
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/BaseTypedMappingSettingsModelBaseRuleModel'
required: true
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/TypedMappingSettingsModel'
x-pretty-name: updateMappingTypeSettings
x-required-privilege:
owner: PLATFORM
targetDomain: SOURCE
type: EDIT
targetId: '{sourceId}'
x-required-privileges:
- owner: PLATFORM
targetDomain: SOURCE
type: EDIT
targetId: '{sourceId}'
x-ui-operation-id: /rest/organizations/paramId/sources/paramId/mappings/types/paramId_put
delete:
tags:
- Mappings
summary: Delete Specific Mappings of Given Type
description: 'Deletes the [mappings](https://docs.coveo.com/en/217/) of a specific [item](https://docs.coveo.com/en/210/)
type.**Required privilege:** Sources - Edit
Privilege required
```
{"owner":"PLATFORM","targetDomain":"SOURCE","type":"EDIT","targetId":"{sourceId}"}
```
**Example:**
`mycoveocloudv2organizationg8tp8wu3`
required: true
schema:
type: string
- name: sourceId
in: path
description: The unique identifier of the target [source](https://docs.coveo.com/en/246/).
**Example:** `mycoveocloudv2organizationg8tp8wu3-gravodalyysjsu34camnvxm2d2y`
required: true
schema:
type: string
- name: typeId
in: path
description: The specific [mapping](https://docs.coveo.com/en/217/) item type to delete.
**Example:** `Video`
required: true
schema:
type: string
- name: rebuild
in: query
description: Whether to rebuild the [source](https://docs.coveo.com/en/246/) after the operation.
**Default:**
`false`
required: false
schema:
type: boolean
default: false
responses:
'204':
description: No Content
x-pretty-name: deleteMappingType
x-required-privilege:
owner: PLATFORM
targetDomain: SOURCE
type: EDIT
targetId: '{sourceId}'
x-required-privileges:
- owner: PLATFORM
targetDomain: SOURCE
type: EDIT
targetId: '{sourceId}'
x-ui-operation-id: /rest/organizations/paramId/sources/paramId/mappings/types/paramId_delete
/rest/organizations/{organizationId}/sources/{sourceId}/mappings/types/{typeId}/rules/{ruleId}:
get:
tags:
- Mappings
summary: Show Specific Mapping Rule
description: 'Shows the [mapping](https://docs.coveo.com/en/217/) rules of a specific [item](https://docs.coveo.com/en/210/)
type.**Required privilege:** Sources - View
Privilege required
```
{"owner":"PLATFORM","targetDomain":"SOURCE","type":"VIEW","targetId":"*"}
```
**Example:**
`mycoveocloudv2organizationg8tp8wu3`
required: true
schema:
type: string
- name: sourceId
in: path
description: The unique identifier of the target [source](https://docs.coveo.com/en/246/).
**Example:** `mycoveocloudv2organizationg8tp8wu3-gravodalyysjsu34camnvxm2d2y`
required: true
schema:
type: string
- name: typeId
in: path
description: The target specific [mapping](https://docs.coveo.com/en/217/) type.
**Example:** `Video`
required: true
schema:
type: string
- name: ruleId
in: path
description: The unique identifier of the specific [mapping](https://docs.coveo.com/en/217/) rule to show.
**Example:**
`wb74lavk6rmbjol3wqhamdspbi`
required: true
schema:
type: string
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/RuleModel'
x-pretty-name: getMappingTypeSettingsRule
x-required-privilege:
owner: PLATFORM
targetDomain: SOURCE
type: VIEW
targetId: '*'
x-required-privileges:
- owner: PLATFORM
targetDomain: SOURCE
type: VIEW
targetId: '*'
x-ui-operation-id: /rest/organizations/paramId/sources/paramId/mappings/types/paramId/rules/paramId_get
put:
tags:
- Mappings
summary: Update Specific Mapping Rule
description: 'Updates a [mapping](https://docs.coveo.com/en/217/) rule of a specific [item](https://docs.coveo.com/en/210/)
type.**Required privilege:** Sources - Edit
Privilege required
```
{"owner":"PLATFORM","targetDomain":"SOURCE","type":"EDIT","targetId":"{sourceId}"}
```
**Example:**
`mycoveocloudv2organizationg8tp8wu3`
required: true
schema:
type: string
- name: sourceId
in: path
description: The unique identifier of the target [source](https://docs.coveo.com/en/246/).
**Example:** `mycoveocloudv2organizationg8tp8wu3-gravodalyysjsu34camnvxm2d2y`
required: true
schema:
type: string
- name: typeId
in: path
description: The target specific [mapping](https://docs.coveo.com/en/217/) type.
**Example:** `Video`
required: true
schema:
type: string
- name: ruleId
in: path
description: The unique identifier of the specific [mapping](https://docs.coveo.com/en/217/) rule to update.
**Example:**
`wb74lavk6rmbjol3wqhamdspbi`
required: true
schema:
type: string
- name: rebuild
in: query
description: Whether to rebuild the [source](https://docs.coveo.com/en/246/) after the operation.
**Default:**
`false`
required: false
schema:
type: boolean
default: false
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/BaseRuleModel'
required: true
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/RuleModel'
x-pretty-name: updateMappingTypeSettingsRule
x-required-privilege:
owner: PLATFORM
targetDomain: SOURCE
type: EDIT
targetId: '{sourceId}'
x-required-privileges:
- owner: PLATFORM
targetDomain: SOURCE
type: EDIT
targetId: '{sourceId}'
x-ui-operation-id: /rest/organizations/paramId/sources/paramId/mappings/types/paramId/rules/paramId_put
delete:
tags:
- Mappings
summary: Delete Specific Mapping Rule
description: 'Deletes a [mapping](https://docs.coveo.com/en/217/) rule of a specific [item](https://docs.coveo.com/en/210/)
type.**Required privilege:** Sources - Edit
Privilege required
```
{"owner":"PLATFORM","targetDomain":"SOURCE","type":"EDIT","targetId":"{sourceId}"}
```
**Example:**
`mycoveocloudv2organizationg8tp8wu3`
required: true
schema:
type: string
- name: sourceId
in: path
description: The unique identifier of the target [source](https://docs.coveo.com/en/246/).
**Example:** `mycoveocloudv2organizationg8tp8wu3-gravodalyysjsu34camnvxm2d2y`
required: true
schema:
type: string
- name: typeId
in: path
description: The target specific [mapping](https://docs.coveo.com/en/217/) type.
**Example:** `Video`
required: true
schema:
type: string
- name: ruleId
in: path
description: The unique identifier of the specific [mapping](https://docs.coveo.com/en/217/) rule to delete.
**Example:**
`wb74lavk6rmbjol3wqhamdspbi`
required: true
schema:
type: string
- name: rebuild
in: query
description: Whether to rebuild the [source](https://docs.coveo.com/en/246/) after the operation.
**Default:**
`false`
required: false
schema:
type: boolean
default: false
responses:
'204':
description: No Content
x-pretty-name: deleteMappingTypeSettingsRule
x-required-privilege:
owner: PLATFORM
targetDomain: SOURCE
type: EDIT
targetId: '{sourceId}'
x-required-privileges:
- owner: PLATFORM
targetDomain: SOURCE
type: EDIT
targetId: '{sourceId}'
x-ui-operation-id: /rest/organizations/paramId/sources/paramId/mappings/types/paramId/rules/paramId_delete
/rest/organizations/{organizationId}/sources/{sourceId}/mappings/common:
get:
tags:
- Mappings
summary: List Common Mappings
description: 'Lists the common [mappings](https://docs.coveo.com/en/217/) of a [source](https://docs.coveo.com/en/246/)
(i.e., the mappings that apply to all [item](https://docs.coveo.com/en/210/) types).**Required privilege:** Sources
- View
Privilege required
```
{"owner":"PLATFORM","targetDomain":"SOURCE","type":"VIEW","targetId":"*"}
```
**Example:**
`mycoveocloudv2organizationg8tp8wu3`
required: true
schema:
type: string
- name: sourceId
in: path
description: The unique identifier of the target [source](https://docs.coveo.com/en/246/).
**Example:** `mycoveocloudv2organizationg8tp8wu3-gravodalyysjsu34camnvxm2d2y`
required: true
schema:
type: string
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/CommonMappingSettingsModel'
x-pretty-name: getCommonMappingSettings
x-required-privilege:
owner: PLATFORM
targetDomain: SOURCE
type: VIEW
targetId: '*'
x-required-privileges:
- owner: PLATFORM
targetDomain: SOURCE
type: VIEW
targetId: '*'
x-ui-operation-id: /rest/organizations/paramId/sources/paramId/mappings/common_get
put:
tags:
- Mappings
summary: Update Common Mappings
description: 'Updates the common [mappings](https://docs.coveo.com/en/217/) of a [source](https://docs.coveo.com/en/246/),
(i.e., the mappings that apply to all [item](https://docs.coveo.com/en/210/) types).**Required privilege:** Sources
- Edit
Privilege required
```
{"owner":"PLATFORM","targetDomain":"SOURCE","type":"EDIT","targetId":"{sourceId}"}
```
**Example:**
`mycoveocloudv2organizationg8tp8wu3`
required: true
schema:
type: string
- name: sourceId
in: path
description: The unique identifier of the target [source](https://docs.coveo.com/en/246/).
**Example:** `mycoveocloudv2organizationg8tp8wu3-gravodalyysjsu34camnvxm2d2y`
required: true
schema:
type: string
- name: rebuild
in: query
description: Whether to rebuild the [source](https://docs.coveo.com/en/246/) after the operation.
**Default:**
`false`
required: false
schema:
type: boolean
default: false
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CommonMappingSettingsModel'
required: true
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/CommonMappingSettingsModel'
x-pretty-name: updateCommonMappingSettings
x-required-privilege:
owner: PLATFORM
targetDomain: SOURCE
type: EDIT
targetId: '{sourceId}'
x-required-privileges:
- owner: PLATFORM
targetDomain: SOURCE
type: EDIT
targetId: '{sourceId}'
x-ui-operation-id: /rest/organizations/paramId/sources/paramId/mappings/common_put
/rest/organizations/{organizationId}/sources/{sourceId}/mappings/common/rules/{ruleId}:
get:
tags:
- Mappings
summary: Show Common Mapping Rule
description: 'Shows a common [mapping](https://docs.coveo.com/en/217/) rule (i.e., a mapping rule that applies to all
[item](https://docs.coveo.com/en/210/) types).**Required privilege:** Sources - View
Privilege
required
```
{"owner":"PLATFORM","targetDomain":"SOURCE","type":"VIEW","targetId":"*"}
```
**Example:**
`mycoveocloudv2organizationg8tp8wu3`
required: true
schema:
type: string
- name: sourceId
in: path
description: The unique identifier of the target [source](https://docs.coveo.com/en/246/).
**Example:** `mycoveocloudv2organizationg8tp8wu3-gravodalyysjsu34camnvxm2d2y`
required: true
schema:
type: string
- name: ruleId
in: path
description: The unique identifier of the mapping rule to show.
**Example:** `teghteb76mvjttvufmxecasmzy`
required: true
schema:
type: string
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/RuleModel'
x-pretty-name: getCommonMappingSettingsRule
x-required-privilege:
owner: PLATFORM
targetDomain: SOURCE
type: VIEW
targetId: '*'
x-required-privileges:
- owner: PLATFORM
targetDomain: SOURCE
type: VIEW
targetId: '*'
x-ui-operation-id: /rest/organizations/paramId/sources/paramId/mappings/common/rules/paramId_get
put:
tags:
- Mappings
summary: Update Common Mapping Rule
description: 'Updates a common [mapping](https://docs.coveo.com/en/217/) rule (i.e., a mapping rule that applies to
all [item](https://docs.coveo.com/en/210/) types).**Required privilege:** Sources - Edit
Privilege
required
```
{"owner":"PLATFORM","targetDomain":"SOURCE","type":"EDIT","targetId":"{sourceId}"}
```
**Example:**
`mycoveocloudv2organizationg8tp8wu3`
required: true
schema:
type: string
- name: sourceId
in: path
description: The unique identifier of the target [source](https://docs.coveo.com/en/246/).
**Example:** `mycoveocloudv2organizationg8tp8wu3-gravodalyysjsu34camnvxm2d2y`
required: true
schema:
type: string
- name: ruleId
in: path
description: The unique identifier of the mapping rule to update.
**Example:** `teghteb76mvjttvufmxecasmzy`
required: true
schema:
type: string
- name: rebuild
in: query
description: Whether to rebuild the [source](https://docs.coveo.com/en/246/) after the operation.
**Default:**
`false`
required: false
schema:
type: boolean
default: false
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/BaseRuleModel'
required: true
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/RuleModel'
x-pretty-name: updateCommonMappingSettingsRule
x-required-privilege:
owner: PLATFORM
targetDomain: SOURCE
type: EDIT
targetId: '{sourceId}'
x-required-privileges:
- owner: PLATFORM
targetDomain: SOURCE
type: EDIT
targetId: '{sourceId}'
x-ui-operation-id: /rest/organizations/paramId/sources/paramId/mappings/common/rules/paramId_put
delete:
tags:
- Mappings
summary: Delete Common Mapping Rule
description: 'Deletes a common [mapping](https://docs.coveo.com/en/217/) rule in a [source](https://docs.coveo.com/en/246/),
(i.e., a mapping rule that applies to all [item](https://docs.coveo.com/en/210/) types.)**Required privilege:**
Sources - Edit
Privilege required
```
{"owner":"PLATFORM","targetDomain":"SOURCE","type":"EDIT","targetId":"{sourceId}"}
```
**Example:**
`mycoveocloudv2organizationg8tp8wu3`
required: true
schema:
type: string
- name: sourceId
in: path
description: The unique identifier of the target [source](https://docs.coveo.com/en/246/).
**Example:** `mycoveocloudv2organizationg8tp8wu3-gravodalyysjsu34camnvxm2d2y`
required: true
schema:
type: string
- name: ruleId
in: path
description: The unique identifier of the mapping rule to delete.
**Example:** `teghteb76mvjttvufmxecasmzy`
required: true
schema:
type: string
- name: rebuild
in: query
description: Whether to rebuild the [source](https://docs.coveo.com/en/246/) after the operation.
**Default:**
`false`
required: false
schema:
type: boolean
default: false
responses:
'204':
description: No Content
x-pretty-name: deleteCommonMappingSettingsRule
x-required-privilege:
owner: PLATFORM
targetDomain: SOURCE
type: EDIT
targetId: '{sourceId}'
x-required-privileges:
- owner: PLATFORM
targetDomain: SOURCE
type: EDIT
targetId: '{sourceId}'
x-ui-operation-id: /rest/organizations/paramId/sources/paramId/mappings/common/rules/paramId_delete
/rest/organizations/{organizationId}/sources/{sourceId}/extensions:
get:
tags:
- Source Extension Configurations
summary: List Extension Configurations
description: 'Lists the [extension](https://docs.coveo.com/en/206/) configurations of a [source](https://docs.coveo.com/en/246/).**Required
privilege:** Sources - View
Privilege required
```
{"owner":"PLATFORM","targetDomain":"SOURCE","type":"VIEW","targetId":"*"}
```
**Example:**
`mycoveocloudv2organizationg8tp8wu3`
required: true
schema:
type: string
- name: sourceId
in: path
description: The unique identifier of the target [source](https://docs.coveo.com/en/246/).
**Example:** `mycoveocloudv2organizationg8tp8wu3-gravodalyysjsu34camnvxm2d2y`
required: true
schema:
type: string
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/SourceExtensionsMap'
x-pretty-name: getSourceExtensions
x-required-privilege:
owner: PLATFORM
targetDomain: SOURCE
type: VIEW
targetId: '*'
x-required-privileges:
- owner: PLATFORM
targetDomain: SOURCE
type: VIEW
targetId: '*'
x-ui-operation-id: /rest/organizations/paramId/sources/paramId/extensions_get
put:
tags:
- Source Extension Configurations
summary: Update Extension Configurations
description: 'Updates the [extension](https://docs.coveo.com/en/206/) configurations of a [source](https://docs.coveo.com/en/246/).**Required
privilege:** Sources - Edit
Privilege required
```
{"owner":"PLATFORM","targetDomain":"SOURCE","type":"EDIT","targetId":"{sourceId}"}
```
**Example:**
`mycoveocloudv2organizationg8tp8wu3`
required: true
schema:
type: string
- name: sourceId
in: path
description: The unique identifier of the target [source](https://docs.coveo.com/en/246/).
**Example:** `mycoveocloudv2organizationg8tp8wu3-gravodalyysjsu34camnvxm2d2y`
required: true
schema:
type: string
- name: rebuild
in: query
description: Whether to rebuild the [source](https://docs.coveo.com/en/246/) after the operation.
**Default:**
`false`
required: false
schema:
type: boolean
default: false
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SourceExtensionsMap'
required: true
responses:
'204':
description: No Content
x-pretty-name: setSourceExtensions
x-required-privilege:
owner: PLATFORM
targetDomain: SOURCE
type: EDIT
targetId: '{sourceId}'
x-required-privileges:
- owner: PLATFORM
targetDomain: SOURCE
type: EDIT
targetId: '{sourceId}'
x-ui-operation-id: /rest/organizations/paramId/sources/paramId/extensions_put
/rest/organizations/{organizationId}/sources/fields/{fieldId}:
get:
tags:
- Sources
summary: Get a Single Field for an Organization
description: 'Privilege required
```
{"owner":"PLATFORM","targetDomain":"FIELD","type":"VIEW","targetId":"*"}
```
Privilege required
```
{"owner":"PLATFORM","targetDomain":"FIELD","type":"EDIT","targetId":"*"}
```
Privilege required
```
{"owner":"PLATFORM","targetDomain":"FIELD","type":"EDIT","targetId":"*"}
```
Privilege required
```
{"owner":"PLATFORM","targetDomain":"FIELD","type":"EDIT","targetId":"*"}
```
Privilege required
```
{"owner":"PLATFORM","targetDomain":"SOURCE","type":"VIEW","targetId":"*"}
```
Privilege required
```
{"owner":"PLATFORM","targetDomain":"SOURCE","type":"CREATE","targetId":"*"}
```
Privilege required
```
{"owner":"PLATFORM","targetDomain":"SOURCE","type":"EDIT","targetId":"{sourceId}"}
```
Privilege required
```
{"owner":"PLATFORM","targetDomain":"SOURCE","type":"EDIT","targetId":"{sourceId}"}
```
Privilege required
```
{"owner":"PLATFORM","targetDomain":"SOURCE","type":"EDIT","targetId":"{sourceId}"}
```
Privilege required
```
{"owner":"PLATFORM","targetDomain":"SOURCE","type":"VIEW","targetId":"*"}
```
Privilege required
```
{"owner":"PLATFORM","targetDomain":"SOURCE","type":"EDIT","targetId":"{sourceId}"}
```
Privilege required
```
{"owner":"PLATFORM","targetDomain":"SOURCE","type":"EDIT","targetId":"{sourceId}"}
```
Privilege required
```
{"owner":"PLATFORM","targetDomain":"SOURCE","type":"EDIT","targetId":"{sourceId}"}
```
Privilege required
```
{"owner":"PLATFORM","targetDomain":"SOURCE","type":"EDIT","targetId":"{sourceId}"}
```
Privilege required
```
{"owner":"PLATFORM","targetDomain":"SOURCE","type":"EDIT","targetId":"{sourceId}"}
```
Privilege required
```
{"owner":"PLATFORM","targetDomain":"SOURCE","type":"EDIT","targetId":"{sourceId}"}
AND
{"owner":"PLATFORM","targetDomain":"SOURCE_METADATA","type":"VIEW","targetId":"*"}
```
**Example:**
`mycoveocloudv2organizationg8tp8wu3`
required: true
schema:
type: string
- name: sourceId
in: path
description: The unique identifier of the target [source](https://docs.coveo.com/en/246/).
**Example:** `mycoveocloudv2organizationg8tp8wu3-gravodalyysjsu34camnvxm2d2y`
required: true
schema:
type: string
- name: page
in: query
required: false
schema:
type: integer
format: int32
default: 0
- name: perPage
in: query
required: false
schema:
type: integer
format: int32
default: 100
- name: filter
in: query
description: Optional filter string. Must be at least 2 characters long to be applied.
required: false
schema:
type: string
- name: sortBy
in: query
required: false
schema:
type: string
- name: order
in: query
required: false
schema:
type: string
default: ASC
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/MetadataReportPageModel'
x-pretty-name: getSourceMetadataReport
x-required-privilege:
owner: PLATFORM
targetDomain: SOURCE
type: EDIT
targetId: '{sourceId}'
x-required-privileges:
- owner: PLATFORM
targetDomain: SOURCE
type: EDIT
targetId: '{sourceId}'
- owner: PLATFORM
targetDomain: SOURCE_METADATA
type: VIEW
targetId: '*'
x-ui-operation-id: /rest/organizations/paramId/sources/paramId/metadata_get
post:
tags:
- Metadata
summary: Create Metadata Report for a Source
description: 'Privilege required
```
{"owner":"PLATFORM","targetDomain":"SOURCE","type":"EDIT","targetId":"{sourceId}"}
AND
{"owner":"PLATFORM","targetDomain":"SOURCE_METADATA","type":"VIEW","targetId":"*"}
```
**Example:**
`mycoveocloudv2organizationg8tp8wu3`
required: true
schema:
type: string
- name: sourceId
in: path
description: The unique identifier of the target [source](https://docs.coveo.com/en/246/).
**Example:** `mycoveocloudv2organizationg8tp8wu3-gravodalyysjsu34camnvxm2d2y`
required: true
schema:
type: string
responses:
'204':
description: No Content
x-pretty-name: createMetadataReport
x-required-privilege:
owner: PLATFORM
targetDomain: SOURCE
type: EDIT
targetId: '{sourceId}'
x-required-privileges:
- owner: PLATFORM
targetDomain: SOURCE
type: EDIT
targetId: '{sourceId}'
- owner: PLATFORM
targetDomain: SOURCE_METADATA
type: VIEW
targetId: '*'
x-ui-operation-id: /rest/organizations/paramId/sources/paramId/metadata_post
/rest/organizations/{organizationId}/sources/{sourceId}/mappings/types:
get:
tags:
- Mappings
summary: List Specific Mappings
description: 'Lists the specific [mappings](https://docs.coveo.com/en/217/) of a [source](https://docs.coveo.com/en/246/)
(i.e., the mappings that apply to specific [item](https://docs.coveo.com/en/210/) types).**Required privilege:**
Sources - View
Privilege required
```
{"owner":"PLATFORM","targetDomain":"SOURCE","type":"VIEW","targetId":"*"}
```
**Example:**
`mycoveocloudv2organizationg8tp8wu3`
required: true
schema:
type: string
- name: sourceId
in: path
description: The unique identifier of the target [source](https://docs.coveo.com/en/246/).
**Example:** `mycoveocloudv2organizationg8tp8wu3-gravodalyysjsu34camnvxm2d2y`
required: true
schema:
type: string
responses:
'200':
description: OK
content:
'*/*':
schema:
type: array
items:
$ref: '#/components/schemas/TypedMappingSettingsModel'
x-pretty-name: getMappingTypes
x-required-privilege:
owner: PLATFORM
targetDomain: SOURCE
type: VIEW
targetId: '*'
x-required-privileges:
- owner: PLATFORM
targetDomain: SOURCE
type: VIEW
targetId: '*'
x-ui-operation-id: /rest/organizations/paramId/sources/paramId/mappings/types_get
post:
tags:
- Mappings
summary: Create Specific Mapping
description: 'Creates a new specific [mapping](https://docs.coveo.com/en/217/) (i.e., a mapping that applies to a specific
[item](https://docs.coveo.com/en/210/) type).**Required privilege:** Sources - Edit
Privilege
required
```
{"owner":"PLATFORM","targetDomain":"SOURCE","type":"EDIT","targetId":"{sourceId}"}
```
**Example:**
`mycoveocloudv2organizationg8tp8wu3`
required: true
schema:
type: string
- name: sourceId
in: path
description: The unique identifier of the target [source](https://docs.coveo.com/en/246/).
**Example:** `mycoveocloudv2organizationg8tp8wu3-gravodalyysjsu34camnvxm2d2y`
required: true
schema:
type: string
- name: rebuild
in: query
description: Whether to rebuild the [source](https://docs.coveo.com/en/246/) after the operation.
**Default:**
`false`
required: false
schema:
type: boolean
default: false
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/BaseTypedMappingSettingsModelBaseRuleModel'
required: true
responses:
'201':
description: Created
content:
'*/*':
schema:
$ref: '#/components/schemas/TypedMappingSettingsModel'
x-pretty-name: addMappingTypes
x-required-privilege:
owner: PLATFORM
targetDomain: SOURCE
type: EDIT
targetId: '{sourceId}'
x-required-privileges:
- owner: PLATFORM
targetDomain: SOURCE
type: EDIT
targetId: '{sourceId}'
x-ui-operation-id: /rest/organizations/paramId/sources/paramId/mappings/types_post
/rest/organizations/{organizationId}/sources/{sourceId}/mappings/types/{typeId}/rules:
get:
tags:
- Mappings
summary: List Specific Mapping Rules of Given Type
description: 'Lists the [mapping](https://docs.coveo.com/en/217/) rules of a specific [item](https://docs.coveo.com/en/210/)
type.**Required privilege:** Sources - View
Privilege required
```
{"owner":"PLATFORM","targetDomain":"SOURCE","type":"VIEW","targetId":"*"}
```
**Example:**
`mycoveocloudv2organizationg8tp8wu3`
required: true
schema:
type: string
- name: sourceId
in: path
description: The unique identifier of the target [source](https://docs.coveo.com/en/246/).
**Example:** `mycoveocloudv2organizationg8tp8wu3-gravodalyysjsu34camnvxm2d2y`
required: true
schema:
type: string
- name: typeId
in: path
description: The unique identifier of the specific [mapping](https://docs.coveo.com/en/217/) [item](https://docs.coveo.com/en/210/)
type to show.
**Example:** `Video`
required: true
schema:
type: string
responses:
'200':
description: OK
content:
'*/*':
schema:
type: array
items:
$ref: '#/components/schemas/RuleModel'
x-pretty-name: getMappingTypeSettingRules
x-required-privilege:
owner: PLATFORM
targetDomain: SOURCE
type: VIEW
targetId: '*'
x-required-privileges:
- owner: PLATFORM
targetDomain: SOURCE
type: VIEW
targetId: '*'
x-ui-operation-id: /rest/organizations/paramId/sources/paramId/mappings/types/paramId/rules_get
post:
tags:
- Mappings
summary: Create Specific Mapping Rule of Given Type
description: 'Creates a new [mapping](https://docs.coveo.com/en/217/) rule of a specific [item](https://docs.coveo.com/en/210/)
type.**Required privilege:** Sources - Edit
Privilege required
```
{"owner":"PLATFORM","targetDomain":"SOURCE","type":"EDIT","targetId":"{sourceId}"}
```
**Example:**
`mycoveocloudv2organizationg8tp8wu3`
required: true
schema:
type: string
- name: sourceId
in: path
description: The unique identifier of the target [source](https://docs.coveo.com/en/246/).
**Example:** `mycoveocloudv2organizationg8tp8wu3-gravodalyysjsu34camnvxm2d2y`
required: true
schema:
type: string
- name: typeId
in: path
description: The type of specific [mapping](https://docs.coveo.com/en/217/) rule to create.
**Example:** `Video`
required: true
schema:
type: string
- name: rebuild
in: query
description: Whether to rebuild the [source](https://docs.coveo.com/en/246/) after the operation.
**Default:**
`false`
required: false
schema:
type: boolean
default: false
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/BaseRuleModel'
required: true
responses:
'201':
description: Created
content:
'*/*':
schema:
$ref: '#/components/schemas/RuleModel'
x-pretty-name: addMappingTypeSettingRule
x-required-privilege:
owner: PLATFORM
targetDomain: SOURCE
type: EDIT
targetId: '{sourceId}'
x-required-privileges:
- owner: PLATFORM
targetDomain: SOURCE
type: EDIT
targetId: '{sourceId}'
x-ui-operation-id: /rest/organizations/paramId/sources/paramId/mappings/types/paramId/rules_post
/rest/organizations/{organizationId}/sources/{sourceId}/mappings/common/rules:
get:
tags:
- Mappings
summary: List Common Mapping Rules
description: 'Lists the common [mapping](https://docs.coveo.com/en/217/) rules of a [source](https://docs.coveo.com/en/246/)
(i.e., the mapping rules that apply to all [item](https://docs.coveo.com/en/210/) types).**Required privilege:**
Sources - View
Privilege required
```
{"owner":"PLATFORM","targetDomain":"SOURCE","type":"VIEW","targetId":"*"}
```
**Example:**
`mycoveocloudv2organizationg8tp8wu3`
required: true
schema:
type: string
- name: sourceId
in: path
description: The unique identifier of the target [source](https://docs.coveo.com/en/246/).
**Example:** `mycoveocloudv2organizationg8tp8wu3-gravodalyysjsu34camnvxm2d2y`
required: true
schema:
type: string
responses:
'200':
description: OK
content:
'*/*':
schema:
type: array
items:
$ref: '#/components/schemas/RuleModel'
x-pretty-name: getCommonMappingSettingsRules
x-required-privilege:
owner: PLATFORM
targetDomain: SOURCE
type: VIEW
targetId: '*'
x-required-privileges:
- owner: PLATFORM
targetDomain: SOURCE
type: VIEW
targetId: '*'
x-ui-operation-id: /rest/organizations/paramId/sources/paramId/mappings/common/rules_get
post:
tags:
- Mappings
summary: Create Common Mapping Rule
description: 'Creates a new [source](https://docs.coveo.com/en/246/) common [mapping](https://docs.coveo.com/en/217/)
rule (i.e., a mapping rule that applies to all [item](https://docs.coveo.com/en/210/) types).**Required privilege:**
Sources - Edit
Privilege required
```
{"owner":"PLATFORM","targetDomain":"SOURCE","type":"EDIT","targetId":"{sourceId}"}
```
**Example:**
`mycoveocloudv2organizationg8tp8wu3`
required: true
schema:
type: string
- name: sourceId
in: path
description: The unique identifier of the target [source](https://docs.coveo.com/en/246/).
**Example:** `mycoveocloudv2organizationg8tp8wu3-gravodalyysjsu34camnvxm2d2y`
required: true
schema:
type: string
- name: rebuild
in: query
description: Whether to rebuild the [source](https://docs.coveo.com/en/246/) after the operation.
**Default:**
`false`
required: false
schema:
type: boolean
default: false
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/BaseRuleModel'
required: true
responses:
'201':
description: Created
content:
'*/*':
schema:
$ref: '#/components/schemas/RuleModel'
x-pretty-name: addCommonMappingSettingsRule
x-required-privilege:
owner: PLATFORM
targetDomain: SOURCE
type: EDIT
targetId: '{sourceId}'
x-required-privileges:
- owner: PLATFORM
targetDomain: SOURCE
type: EDIT
targetId: '{sourceId}'
x-ui-operation-id: /rest/organizations/paramId/sources/paramId/mappings/common/rules_post
/rest/organizations/{organizationId}/sources/{sourceId}/mappings/batch/update:
post:
tags:
- Mappings
summary: Update Mapping Rules in Batch
description: 'Updates [mappings](https://docs.coveo.com/en/217/) in batch for a specific [source](https://docs.coveo.com/en/246/).**Required
privilege:** Sources - Edit
Privilege required
```
{"owner":"PLATFORM","targetDomain":"SOURCE","type":"EDIT","targetId":"{sourceId}"}
```
**Example:**
`mycoveocloudv2organizationg8tp8wu3`
required: true
schema:
type: string
- name: sourceId
in: path
description: The unique identifier of the target [source](https://docs.coveo.com/en/246/).
**Example:** `mycoveocloudv2organizationg8tp8wu3-gravodalyysjsu34camnvxm2d2y`
required: true
schema:
type: string
- name: rebuild
in: query
description: Whether to rebuild the [source](https://docs.coveo.com/en/246/) after the operation.
**Default:**
`false`
required: false
schema:
type: boolean
default: false
requestBody:
content:
application/json:
schema:
type: array
description: The [mappings](https://docs.coveo.com/en/217/) to update.
items:
$ref: '#/components/schemas/TypedMappingSettingsModel'
required: true
responses:
'201':
description: Created
content:
'*/*':
schema:
$ref: '#/components/schemas/BatchOperationProgressModelTypedMappingSettingsModel'
x-pretty-name: updateMappingTypesBatch
x-required-privilege:
owner: PLATFORM
targetDomain: SOURCE
type: EDIT
targetId: '{sourceId}'
x-required-privileges:
- owner: PLATFORM
targetDomain: SOURCE
type: EDIT
targetId: '{sourceId}'
x-ui-operation-id: /rest/organizations/paramId/sources/paramId/mappings/batch/update_post
/rest/organizations/{organizationId}/sources/{sourceId}/mappings/batch/delete:
post:
tags:
- Mappings
summary: Delete Mapping Rules in Batch
description: 'Deletes [mappings](https://docs.coveo.com/en/217/) in batch for a specific [source](https://docs.coveo.com/en/246/).**Required
privilege:** Sources - Edit
Privilege required
```
{"owner":"PLATFORM","targetDomain":"SOURCE","type":"EDIT","targetId":"{sourceId}"}
```
**Example:**
`mycoveocloudv2organizationg8tp8wu3`
required: true
schema:
type: string
- name: sourceId
in: path
description: The unique identifier of the target [source](https://docs.coveo.com/en/246/).
**Example:** `mycoveocloudv2organizationg8tp8wu3-gravodalyysjsu34camnvxm2d2y`
required: true
schema:
type: string
- name: rebuild
in: query
description: Whether to rebuild the [source](https://docs.coveo.com/en/246/) after the operation.
**Default:**
`false`
required: false
schema:
type: boolean
default: false
requestBody:
content:
application/json:
schema:
type: array
description: The [mappings](https://docs.coveo.com/en/217/) to delete.
items:
$ref: '#/components/schemas/TypedMappingSettingsModel'
required: true
responses:
'201':
description: Created
content:
'*/*':
schema:
$ref: '#/components/schemas/BatchOperationProgressModelTypedMappingSettingsModel'
x-pretty-name: deleteMappingTypesBatch
x-required-privilege:
owner: PLATFORM
targetDomain: SOURCE
type: EDIT
targetId: '{sourceId}'
x-required-privileges:
- owner: PLATFORM
targetDomain: SOURCE
type: EDIT
targetId: '{sourceId}'
x-ui-operation-id: /rest/organizations/paramId/sources/paramId/mappings/batch/delete_post
/rest/organizations/{organizationId}/sources/{sourceId}/mappings/batch/create:
post:
tags:
- Mappings
summary: Create Mapping Rules in Batch
description: 'Creates new [mappings](https://docs.coveo.com/en/217/) in batch for a specific [source](https://docs.coveo.com/en/246/).**Required
privilege:** Sources - Edit
Privilege required
```
{"owner":"PLATFORM","targetDomain":"SOURCE","type":"EDIT","targetId":"{sourceId}"}
```
**Example:**
`mycoveocloudv2organizationg8tp8wu3`
required: true
schema:
type: string
- name: sourceId
in: path
description: The unique identifier of the target [source](https://docs.coveo.com/en/246/).
**Example:** `mycoveocloudv2organizationg8tp8wu3-gravodalyysjsu34camnvxm2d2y`
required: true
schema:
type: string
- name: rebuild
in: query
description: Whether to rebuild the [source](https://docs.coveo.com/en/246/) after the operation.
**Default:**
`false`
required: false
schema:
type: boolean
default: false
requestBody:
content:
application/json:
schema:
type: array
description: The [mappings](https://docs.coveo.com/en/217/) to create.
items:
$ref: '#/components/schemas/TypedMappingSettingsModel'
required: true
responses:
'201':
description: Created
content:
'*/*':
schema:
$ref: '#/components/schemas/BatchOperationProgressModelTypedMappingSettingsModel'
x-pretty-name: addMappingTypesBatch
x-required-privilege:
owner: PLATFORM
targetDomain: SOURCE
type: EDIT
targetId: '{sourceId}'
x-required-privileges:
- owner: PLATFORM
targetDomain: SOURCE
type: EDIT
targetId: '{sourceId}'
x-ui-operation-id: /rest/organizations/paramId/sources/paramId/mappings/batch/create_post
/rest/organizations/{organizationId}/sources/{sourceId}/incrementalRefresh:
post:
tags:
- Sources
summary: Apply an Incremental Refresh Operation on a Source
description: 'Privilege required
```
{"owner":"PLATFORM","targetDomain":"SOURCE","type":"EDIT","targetId":"{sourceId}"}
```
Privilege required
```
{"owner":"PLATFORM","targetDomain":"SOURCE","type":"EDIT","targetId":"{sourceId}"}
```
Privilege required
```
{"owner":"PLATFORM","targetDomain":"SOURCE","type":"EDIT","targetId":"{sourceId}"}
```
Privilege required
```
{"owner":"PLATFORM","targetDomain":"SOURCE","type":"EDIT","targetId":"{sourceId}"}
AND
{"owner":"PLATFORM","targetDomain":"SOURCE","type":"CREATE","targetId":"*"}
```
Privilege required
```
{"owner":"PLATFORM","targetDomain":"SOURCE","type":"EDIT","targetId":"{sourceId}"}
```
Privilege required
```
{"owner":"PLATFORM","targetDomain":"SOURCE","type":"EDIT","targetId":"{sourceId}"}
```
Privilege required
```
{"owner":"PLATFORM","targetDomain":"SOURCE","type":"EDIT","targetId":"{sourceId}"}
```
Privilege required
```
{"owner":"PLATFORM","targetDomain":"SOURCE","type":"CREATE","targetId":"*"}
```
Privilege required
```
{"owner":"PLATFORM","targetDomain":"SOURCE","type":"VIEW","targetId":"*"}
```
**Example:**
[`mycoveocloudv2organizationg8tp8wu3-gravodalyysjsu34camnvxm2d2y`, `mycoveocloudv2organizationg8tp8wu3-wsqbiw2mkrmktzu5jupmp72n3i`]
items:
type: string
required: true
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/GetSourcesOutArgs'
x-pretty-name: getSourcesAndPageInformationsByIds
x-required-privilege:
owner: PLATFORM
targetDomain: SOURCE
type: VIEW
targetId: '*'
x-required-privileges:
- owner: PLATFORM
targetDomain: SOURCE
type: VIEW
targetId: '*'
x-ui-operation-id: /rest/organizations/paramId/sources/pages/ids_post
/rest/organizations/{organizationId}/sources/fields:
get:
tags:
- Sources
summary: Get All Fields for an Organization
description: 'Privilege required
```
{"owner":"PLATFORM","targetDomain":"FIELD","type":"VIEW","targetId":"*"}
```
Privilege required
```
{"owner":"PLATFORM","targetDomain":"FIELD","type":"CREATE","targetId":"*"}
```
Privilege required
```
{"owner":"PLATFORM","targetDomain":"FIELD","type":"CREATE","targetId":"*"}
```
Privilege required
```
{"owner":"PLATFORM","targetDomain":"SOURCE","type":"EDIT","targetId":"{sourceId}"}
AND
{"owner":"PLATFORM","targetDomain":"SOURCE_METADATA","type":"VIEW","targetId":"*"}
```
**Example:**
`mycoveocloudv2organizationg8tp8wu3`
required: true
schema:
type: string
- name: sourceId
in: path
description: The unique identifier of the target [source](https://docs.coveo.com/en/246/).
**Example:** `mycoveocloudv2organizationg8tp8wu3-gravodalyysjsu34camnvxm2d2y`
required: true
schema:
type: string
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/SourceMetadataStatusModel'
x-pretty-name: getSourceMetadataStatus
x-required-privilege:
owner: PLATFORM
targetDomain: SOURCE
type: EDIT
targetId: '{sourceId}'
x-required-privileges:
- owner: PLATFORM
targetDomain: SOURCE
type: EDIT
targetId: '{sourceId}'
- owner: PLATFORM
targetDomain: SOURCE_METADATA
type: VIEW
targetId: '*'
x-ui-operation-id: /rest/organizations/paramId/sources/paramId/metadata/status_get
/rest/organizations/{organizationId}/sources/{sourceId}/light:
get:
tags:
- Sources
summary: Get a Single Source
description: 'Privilege required
```
{"owner":"PLATFORM","targetDomain":"SOURCE","type":"VIEW","targetId":"*"}
```
Privilege required
```
{"owner":"PLATFORM","targetDomain":"SOURCE","type":"VIEW","targetId":"*"}
```
**Example:**
`mycoveocloudv2organizationg8tp8wu3`
required: true
schema:
type: string
- name: sourceId
in: path
description: The unique identifier of the target [source](https://docs.coveo.com/en/246/).
**Example:** `mycoveocloudv2organizationg8tp8wu3-gravodalyysjsu34camnvxm2d2y`
required: true
schema:
type: string
responses:
'200':
description: OK
content:
'*/*':
schema:
uniqueItems: true
type: array
items:
type: string
x-pretty-name: getSourceItemTypes
x-required-privilege:
owner: PLATFORM
targetDomain: SOURCE
type: VIEW
targetId: '*'
x-required-privileges:
- owner: PLATFORM
targetDomain: SOURCE
type: VIEW
targetId: '*'
x-ui-operation-id: /rest/organizations/paramId/sources/paramId/itemTypes_get
/rest/organizations/{organizationId}/sources/{sourceId}/configuration/snapshot:
get:
tags:
- Sources
summary: Get the Snapshot of the Source Configuration at the Provided Activity.
description: 'Privilege required
```
{"owner":"PLATFORM","targetDomain":"SOURCE","type":"EDIT","targetId":"{sourceId}"}
```
**Example:**
`mycoveocloudv2organizationg8tp8wu3`
required: true
schema:
type: string
- name: sourceId
in: path
description: The unique identifier of the target [source](https://docs.coveo.com/en/246/).
**Example:** `mycoveocloudv2organizationg8tp8wu3-gravodalyysjsu34camnvxm2d2y`
required: true
schema:
type: string
- name: activityId
in: query
required: true
schema:
type: string
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/SourceConfigSnapshotModel'
x-pretty-name: getSourceSnapshot
x-required-privilege:
owner: PLATFORM
targetDomain: SOURCE
type: EDIT
targetId: '{sourceId}'
x-required-privileges:
- owner: PLATFORM
targetDomain: SOURCE
type: EDIT
targetId: '{sourceId}'
x-ui-operation-id: /rest/organizations/paramId/sources/paramId/configuration/snapshot_get
/rest/organizations/{organizationId}/sources/{sourceId}/configuration/salesforce/objects/{objectName}:
get:
tags:
- Sources
summary: Get an Object Fields for a Given Source.
description: 'Privilege required
```
{"owner":"PLATFORM","targetDomain":"SOURCE","type":"VIEW","targetId":"*"}
```
Privilege required
```
{"owner":"PLATFORM","targetDomain":"SOURCE","type":"VIEW","targetId":"*"}
```
Privilege required
```
{"owner":"PLATFORM","targetDomain":"SOURCE","type":"VIEW","targetId":"*"}
```
Privilege required
```
{"owner":"PLATFORM","targetDomain":"SOURCE","type":"VIEW","targetId":"*"}
```
Privilege required
```
{"owner":"PLATFORM","targetDomain":"SOURCE","type":"VIEW","targetId":"*"}
```
Privilege required
```
{"owner":"PLATFORM","targetDomain":"SOURCE","type":"VIEW","targetId":"*"}
```
Privilege required
```
{"owner":"PLATFORM","targetDomain":"FIELD","type":"VIEW","targetId":"*"}
```
Privilege required
```
{"owner":"PLATFORM","targetDomain":"SOURCE","type":"VIEW","targetId":"*"}
```
Privilege required
```
{"owner":"PLATFORM","targetDomain":"FIELD","type":"EDIT","targetId":"*"}
```
'
enum:
- UNKNOWN
- VALID
- PENDING
- INCOMPLETE
- IN_ERROR
- WARNING
permissionLevels:
type: array
description: The [permission levels](https://docs.coveo.com/en/225/).
items:
$ref: '#/components/schemas/PermissionLevelModel'
permissionModelStateRootCauseModel:
$ref: '#/components/schemas/PermissionModelStateRootCauseModel'
description: The item [permission model](https://docs.coveo.com/en/225/).See [Permission Details Tab](https://docs.coveo.com/en/1712/#permission-details-tab).
DocumentProcessor:
type: object
properties:
type:
type: string
parameters:
$ref: '#/components/schemas/DocumentProcessorParameters'
DocumentProcessorConfig:
type: object
properties:
maxHTMLOutputSize:
type: integer
format: int32
maxTextOutputSize:
type: integer
format: int32
excelFloatingPointPrecision:
type: integer
format: int32
imageMinimumSize:
type: integer
format: int32
timeout:
type: integer
format: int32
indexExcelNumbers:
type: boolean
styleSheet:
type: string
languagesSettings:
type: string
maximumDocumentSize:
type: integer
format: int64
maximumNumberOfPermissions:
type: integer
format: int32
maximumMetaSize:
type: integer
format: int32
maximumTotalMetaSize:
type: integer
format: int32
maximumNumberOfMeta:
type: integer
format: int32
maximumIdentityNameSize:
type: integer
format: int32
maximumIdentityTotalSize:
type: integer
format: int32
memoryLimits:
$ref: '#/components/schemas/MemoryLimits'
pipelineStateTtl:
type: integer
format: int32
pipelineStateSizeLimit:
type: integer
format: int32
titleGrammaticalScoreWeight:
type: number
format: double
titleLengthProbabilityWeight:
type: number
format: double
titlePercentageOfCapsFirstLettersWeight:
type: number
format: double
titlePositionScoreWeight:
type: number
format: double
fieldMappingOrigin:
type: string
summarySize:
type: integer
format: int32
maximumNumberOfPagesToConvert:
type: integer
format: int32
generateHTML:
type: boolean
useClickableUriAsBasePath:
type: boolean
addRawTextDataStream:
type: boolean
beautifyDocuments:
type: boolean
indexMeta:
type: boolean
saveTextDataStream:
type: boolean
openResultWithQuickView:
type: boolean
summarizeDocument:
type: boolean
saveExcerptBlob:
type: boolean
excerptSource:
type: string
enum:
- Document
- Summary
charsetDetectionHint:
$ref: '#/components/schemas/CharsetDetectionHint'
languageHints:
type: array
items:
$ref: '#/components/schemas/LanguageHint'
extensionSettings:
$ref: '#/components/schemas/ExtensionSettings'
generateMarkdown:
type: boolean
markdownTimeout:
type: integer
format: int32
sourceInformation:
$ref: '#/components/schemas/SourceInformation'
uniqueTermsPerDocument:
type: integer
format: int32
DocumentProcessorParameters:
type: object
properties:
values:
type: object
additionalProperties:
type: string
deleteOnError:
type: boolean
condition:
$ref: '#/components/schemas/ConditionNode'
streams:
type: array
items:
type: string
name:
type: string
memoryLimit:
type: integer
format: int32
DropboxForBusinessSourceModel:
type: object
allOf:
- $ref: '#/components/schemas/SourceModel'
- type: object
properties:
teamName:
type: string
accessToken:
type: string
accessTokenGuid:
type: string
refreshToken:
type: string
refreshTokenGuid:
type: string
ExtensionSetting:
type: object
properties:
customConverter:
$ref: '#/components/schemas/DocumentProcessor'
action:
type: string
enum:
- Retrieve
- Reference
- Ignore
actionOnError:
type: string
enum:
- Reference
- Ignore
converter:
type: string
enum:
- Detect
- Skip
- Html
- IFilter
- Wordperfect
- Rtf
- Excel
- Word
- Pdf
- Powerpoint
- PlainText
- Msg
- Mime
- Image
useContentType:
type: boolean
indexContainer:
type: boolean
fileTypeValue:
type: string
generateThumbnail:
type: boolean
useExternalHTMLGenerator:
type: boolean
convertDirectlyToHtml:
type: boolean
openResultWithQuickView:
type: boolean
summarizeDocument:
type: boolean
saveExcerptBlob:
type: boolean
excerptSource:
type: string
enum:
- Document
- Summary
ExtensionSettingByExtension:
type: object
properties:
extensions:
type: array
items:
type: string
extensionSetting:
$ref: '#/components/schemas/ExtensionSetting'
ExtensionSettings:
type: object
properties:
noExtension:
$ref: '#/components/schemas/ExtensionSetting'
other:
$ref: '#/components/schemas/ExtensionSetting'
byExtensions:
type: array
items:
$ref: '#/components/schemas/ExtensionSettingByExtension'
byContentTypes:
type: array
items:
$ref: '#/components/schemas/ExtensionSettingByExtension'
FileSourceModel:
type: object
allOf:
- $ref: '#/components/schemas/SourceModel'
- type: object
properties:
username:
type: string
password:
type: string
hasPassword:
type: boolean
activeDirectoryUsername:
type: string
activeDirectoryPassword:
type: string
hasActiveDirectoryPassword:
type: boolean
activeDirectoryEmailAttributes:
type: array
items:
type: string
activeDirectoryExpandTrustedDomains:
type: boolean
activeDirectoryExpandWellKnowns:
type: boolean
activeDirectoryTlsMode:
type: string
useActiveDirectoryPermissions:
type: boolean
hasExpandedSecurityProvider:
type: boolean
expandBeforeFiltering:
type: boolean
expandMailArchives:
type: boolean
indexSharePermissions:
type: boolean
startingAddresses:
type: array
items:
type: string
FormAction:
type: object
properties:
type:
type: string
value:
type: string
elementIdentifier:
$ref: '#/components/schemas/FormElementIdentifier'
waitDelayInMilliseconds:
type: integer
format: int32
FormAuthStep:
type: object
properties:
url:
type: string
pageContainsValue:
type: string
urlContainsValue:
type: string
name:
type: string
waitDelayInMilliseconds:
type: integer
format: int32
actions:
type: array
items:
$ref: '#/components/schemas/FormAction'
FormAuthenticationConfig:
type: object
properties:
actionMethod:
type: string
formContentType:
type: string
actionUrl:
type: string
addFoundInputs:
type: boolean
authenticationFailed:
$ref: '#/components/schemas/AuthenticationFailedConfiguration'
inputs:
type: array
items:
$ref: '#/components/schemas/FormInput'
formId:
type: string
formUrl:
type: string
enableJavaScript:
type: boolean
forceLogin:
type: boolean
javaScriptLoadingDelayInMilliseconds:
type: integer
format: int32
customLoginSequence:
$ref: '#/components/schemas/CustomLoginSequence'
postLoginSequence:
$ref: '#/components/schemas/PostLoginSequence'
getCookiesFromWebDriverInsteadOfCache:
type: boolean
FormElementIdentifier:
type: object
properties:
identifier:
type: string
type:
type: string
findType:
type: string
FormInput:
type: object
properties:
name:
type: string
value:
type: string
inputType:
type: string
enum:
- Input
- Username
- Password
GenericRestSourceModel:
type: object
allOf:
- $ref: '#/components/schemas/SourceModel'
- type: object
properties:
username:
type: string
password:
type: string
hasPassword:
type: boolean
restConfiguration:
type: string
restPermissionConfiguration:
type: string
clientId:
type: string
clientSecret:
type: string
refreshToken:
type: string
apiKey:
type: string
hasApiKey:
type: boolean
hasClientSecret:
type: boolean
hasRefreshToken:
type: boolean
providerType:
type: string
enum:
- ACTIVE_DIRECTORY2
- BOX
- CLAIMS
- CLAIMS_TO_EMAIL
- CONFLUENCE
- CONFLUENCE2
- CUSTOM
- DATABASE
- DROPBOX_FOR_BUSINESS
- EMAIL
- EXPANDED
- FILE
- GOOGLE_DRIVE_DOMAIN_WIDE
- GENERIC_REST
- GRAPHQL
- JIRA2
- JIVE
- KHOROS_COMMUNITY
- MICROSOFT_DYNAMICS
- OFFICE365
- SALESFORCE
- SERVICENOW
- SHAREPOINT
- SHAREPOINT_ONLINE
- SITECORE
- SLACK
- ZENDESK
GoogleDriveDomainWideSourceModel:
type: object
allOf:
- $ref: '#/components/schemas/SourceModel'
- type: object
properties:
googleAppsDomain:
type: string
serviceAccountEmail:
type: string
privateKeyFile:
type: string
usersToCrawl:
type: string
domainAdminEmail:
type: string
crawlTrashedItems:
type: boolean
crawlCustomProperties:
type: boolean
indexSharedDrives:
type: boolean
indexUserDrives:
type: boolean
crawlFolders:
type: boolean
mimeTypesToIgnore:
type: string
itemsModificationPeriod:
$ref: '#/components/schemas/ItemsModificationPeriod'
GraphQlSourceModel:
type: object
allOf:
- $ref: '#/components/schemas/SourceModel'
- type: object
properties:
username:
type: string
password:
type: string
hasPassword:
type: boolean
restConfiguration:
type: string
restPermissionConfiguration:
type: string
clientId:
type: string
clientSecret:
type: string
refreshToken:
type: string
apiKey:
type: string
hasApiKey:
type: boolean
hasClientSecret:
type: boolean
hasRefreshToken:
type: boolean
useGraphQl:
type: boolean
queries:
type: string
providerType:
type: string
enum:
- ACTIVE_DIRECTORY2
- BOX
- CLAIMS
- CLAIMS_TO_EMAIL
- CONFLUENCE
- CONFLUENCE2
- CUSTOM
- DATABASE
- DROPBOX_FOR_BUSINESS
- EMAIL
- EXPANDED
- FILE
- GOOGLE_DRIVE_DOMAIN_WIDE
- GENERIC_REST
- GRAPHQL
- JIRA2
- JIVE
- KHOROS_COMMUNITY
- MICROSOFT_DYNAMICS
- OFFICE365
- SALESFORCE
- SERVICENOW
- SHAREPOINT
- SHAREPOINT_ONLINE
- SITECORE
- SLACK
- ZENDESK
IdAndDisplayNameModel:
type: object
properties:
id:
type: string
displayName:
type: string
ItemsModificationPeriod:
type: object
properties:
Amount:
type: integer
format: int64
writeOnly: true
TimeSpan:
type: string
writeOnly: true
enum:
- Day
- Week
- Month
- Year
amount:
type: integer
format: int64
timespan:
type: string
enum:
- Day
- Week
- Month
- Year
Jira2HostedSourceModel:
type: object
allOf:
- $ref: '#/components/schemas/SourceModel'
- type: object
properties:
username:
type: string
password:
type: string
hasPassword:
type: boolean
urls:
type: array
items:
type: string
serverUrl:
type: string
indexAttachments:
type: boolean
indexComments:
type: boolean
indexWorkLogs:
type: boolean
usePersonalAccessToken:
type: boolean
supportCommentPermissions:
type: boolean
apiKey:
type: string
useApiKey:
type: boolean
Jira2SourceModel:
type: object
allOf:
- $ref: '#/components/schemas/SourceModel'
- type: object
properties:
username:
type: string
password:
type: string
hasPassword:
type: boolean
urls:
type: array
items:
type: string
serverUrl:
type: string
indexAttachments:
type: boolean
indexComments:
type: boolean
indexWorkLogs:
type: boolean
useOAuth2Authentication:
type: boolean
crawlingAccount:
type: string
cloudId:
type: string
clientId:
type: string
hasOrganizationsApiKey:
type: boolean
organizationsApiKey:
type: string
atlassianOrganizationId:
type: string
useAtlassianOrganizationApi:
type: boolean
oauthRefreshTokenGuid:
type: string
oauthRefreshToken:
type: string
JiveHostedSourceModel:
type: object
allOf:
- $ref: '#/components/schemas/SourceModel'
- type: object
properties:
username:
type: string
password:
type: string
hasPassword:
type: boolean
activeDirectoryUsername:
type: string
activeDirectoryPassword:
type: string
hasActiveDirectoryPassword:
type: boolean
activeDirectoryEmailAttributes:
type: array
items:
type: string
activeDirectoryExpandTrustedDomains:
type: boolean
activeDirectoryExpandWellKnowns:
type: boolean
activeDirectoryTlsMode:
type: string
useActiveDirectoryPermissions:
type: boolean
hasExpandedSecurityProvider:
type: boolean
instanceUrl:
type: string
startingSpaceUrl:
type: string
substitutionLocale:
type: string
substitutionTheme:
type: string
placesTitles:
type: string
ignoreItemsOfTypes:
type: string
localizedItemTypes:
type: string
indexSpaces:
type: boolean
indexProjects:
type: boolean
indexGroups:
type: boolean
indexSystemBlogs:
type: boolean
indexPeople:
type: boolean
indexPublishedOnly:
type: boolean
allowAnonymousAccess:
type: boolean
usersRegexMatch:
type: string
usersRegexReplacement:
type: string
metadataIndexers:
type: string
JiveSourceModel:
type: object
allOf:
- $ref: '#/components/schemas/SourceModel'
- type: object
properties:
username:
type: string
password:
type: string
hasPassword:
type: boolean
activeDirectoryUsername:
type: string
activeDirectoryPassword:
type: string
hasActiveDirectoryPassword:
type: boolean
activeDirectoryEmailAttributes:
type: array
items:
type: string
activeDirectoryExpandTrustedDomains:
type: boolean
activeDirectoryExpandWellKnowns:
type: boolean
activeDirectoryTlsMode:
type: string
useActiveDirectoryPermissions:
type: boolean
hasExpandedSecurityProvider:
type: boolean
instanceUrl:
type: string
startingSpaceUrl:
type: string
substitutionLocale:
type: string
substitutionTheme:
type: string
placesTitles:
type: string
ignoreItemsOfTypes:
type: string
localizedItemTypes:
type: string
indexSpaces:
type: boolean
indexProjects:
type: boolean
indexGroups:
type: boolean
indexSystemBlogs:
type: boolean
indexPeople:
type: boolean
indexPublishedOnly:
type: boolean
allowAnonymousAccess:
type: boolean
usersRegexMatch:
type: string
usersRegexReplacement:
type: string
metadataIndexers:
type: string
KhorosSourceModel:
type: object
allOf:
- $ref: '#/components/schemas/SourceModel'
- type: object
properties:
username:
type: string
password:
type: string
hasPassword:
type: boolean
urls:
type: array
items:
type: string
fetchMessageAttachments:
type: boolean
fetchUsers:
type: boolean
fetchMessageTags:
type: boolean
ignoreMessagesOlderThan:
type: string
restApiUrl:
type: string
usernameForRoleSync:
type: string
LanguageHint:
type: object
properties:
language:
type: string
probability:
type: number
format: double
MappingModel:
type: object
properties:
id:
type: string
kind:
type: string
deprecated: true
enum:
- COMMON
- MAPPING
type:
type: string
fieldName:
type: string
extractionMethod:
type: string
content:
type: string
deprecated: true
rules:
type: array
items:
type: string
fieldTypeHint:
type: string
enum:
- LONG
- LONG_64
- DOUBLE
- DATE
- STRING
- VECTOR
MemoryLimits:
type: object
properties:
conversionLimit:
type: integer
format: int32
extensionLimit:
type: integer
format: int32
mappingLimit:
type: integer
format: int32
MetafieldConfiguration:
type: object
properties:
namespace:
type: string
key:
type: string
name:
type: string
MicrosoftDynamicsCondition:
type: object
properties:
attribute:
type: string
operator:
type: string
type:
type: string
enum:
- STRING
- NUMBER
- DATE
- BOOLEAN
- UNARY
values:
type: array
items:
type: string
MicrosoftDynamicsConditions:
type: object
properties:
conditions:
type: array
items:
$ref: '#/components/schemas/MicrosoftDynamicsCondition'
MicrosoftDynamicsFetchXmlQueries:
type: object
properties:
queries:
type: array
items:
$ref: '#/components/schemas/MicrosoftDynamicsFetchXmlQuery'
MicrosoftDynamicsFetchXmlQuery:
type: object
properties:
id:
type: string
name:
type: string
queryXml:
type: string
MicrosoftDynamicsObject:
type: object
properties:
attachment:
type: string
attributes:
type: array
items:
type: string
conditions:
type: array
items:
$ref: '#/components/schemas/MicrosoftDynamicsConditions'
name:
type: string
relations:
type: array
items:
$ref: '#/components/schemas/MicrosoftDynamicsRelation'
MicrosoftDynamicsRelation:
type: object
properties:
alias:
type: string
attributes:
type: array
items:
type: string
fromAttribute:
type: string
toAttribute:
type: string
toEntity:
type: string
MicrosoftDynamicsSourceModel:
type: object
allOf:
- $ref: '#/components/schemas/SourceModel'
- type: object
properties:
username:
type: string
password:
type: string
hasPassword:
type: boolean
discoveryServiceUrl:
type: string
enableS2SAuthentication:
type: boolean
objectsToGet:
type: array
items:
$ref: '#/components/schemas/MicrosoftDynamicsObject'
genericObjectsToGet:
type: string
organizationUniqueName:
type: string
recordsPageSize:
type: integer
format: int32
writeOnly: true
urls:
type: array
items:
type: string
fetchXmlQueries:
$ref: '#/components/schemas/MicrosoftDynamicsFetchXmlQueries'
oauthRefreshTokenGuid:
type: string
oauthResourceGuid:
type: string
oauthResource:
type: string
recordPageSize:
type: integer
format: int32
NextOperation:
type: object
properties:
operationType:
type: string
enum:
- REBUILD
- FULL_REFRESH
- INCREMENTAL_REFRESH
- SECURITY_PROVIDER_REFRESH
- SECURITY_PROVIDER_REFRESH_ENTITIES_IN_ERROR
- SECURITY_PROVIDER_REFRESH_ENTITIES_NOT_UPDATED
- SECURITY_CACHE_REFRESH
- SECURITY_CACHE_REFRESH_ENTITIES_IN_ERROR
timestamp:
type: string
format: date-time
PermissionLevelModel:
type: object
properties:
name:
type: string
permissionSets:
type: array
items:
$ref: '#/components/schemas/PermissionSetModel'
description: The [permission levels](https://docs.coveo.com/en/225/).
PermissionModelStateRootCauseModel:
type: object
properties:
entityState:
type: string
enum:
- UNKNOWN
- UP_TO_DATE
- NOT_UPDATED
- OUT_OF_DATE
- IN_ERROR
- DISABLED
entityInformation:
$ref: '#/components/schemas/DetailedSecurityIdentityModel'
PermissionSetModel:
type: object
properties:
anonymousAllowed:
type: boolean
name:
type: string
permissions:
type: array
items:
$ref: '#/components/schemas/SinglePermissionModel'
PostLoginSequence:
type: object
properties:
url:
type: string
pageContainsValue:
type: string
urlContainsValue:
type: string
name:
type: string
steps:
type: array
items:
$ref: '#/components/schemas/FormAuthStep'
PushSourceModel:
type: object
allOf:
- $ref: '#/components/schemas/SourceModel'
RSSSourceModel:
type: object
allOf:
- $ref: '#/components/schemas/SourceModel'
- type: object
properties:
username:
type: string
password:
type: string
hasPassword:
type: boolean
urls:
type: array
items:
type: string
SAPSourceModel:
type: object
allOf:
- $ref: '#/components/schemas/SourceModel'
- type: object
properties:
username:
type: string
password:
type: string
hasPassword:
type: boolean
restConfiguration:
type: string
restPermissionConfiguration:
type: string
clientId:
type: string
clientSecret:
type: string
refreshToken:
type: string
apiKey:
type: string
hasApiKey:
type: boolean
hasClientSecret:
type: boolean
hasRefreshToken:
type: boolean
providerType:
type: string
enum:
- ACTIVE_DIRECTORY2
- BOX
- CLAIMS
- CLAIMS_TO_EMAIL
- CONFLUENCE
- CONFLUENCE2
- CUSTOM
- DATABASE
- DROPBOX_FOR_BUSINESS
- EMAIL
- EXPANDED
- FILE
- GOOGLE_DRIVE_DOMAIN_WIDE
- GENERIC_REST
- GRAPHQL
- JIRA2
- JIVE
- KHOROS_COMMUNITY
- MICROSOFT_DYNAMICS
- OFFICE365
- SALESFORCE
- SERVICENOW
- SHAREPOINT
- SHAREPOINT_ONLINE
- SITECORE
- SLACK
- ZENDESK
SalesforceCondition:
type: object
properties:
fieldName:
type: string
operator:
type: string
enum:
- EQUALS
- NOT_EQUALS
- LESS_THAN
- LESS_OR_EQUAL_THAN
- GREATER_THAN
- GREATER_OR_EQUAL_THAN
- LIKE
- NOT_LIKE
- INCLUDES
- EXCLUDES
- IN
- NOT_IN
value:
type: string
inConditionValues:
type: array
items:
$ref: '#/components/schemas/SalesforceInConditionValue'
SalesforceField:
type: object
properties:
name:
type: string
label:
type: string
nestedLabel:
type: string
type:
type: string
indexed:
type: boolean
mandatory:
type: boolean
custom:
type: boolean
mappings:
uniqueItems: true
type: array
items:
$ref: '#/components/schemas/MappingModel'
values:
type: array
items:
type: string
referenceTypes:
type: array
items:
type: string
relationshipName:
type: string
relationshipNameField:
type: string
relationshipParent:
type: boolean
relationshipPolymorphic:
type: boolean
SalesforceInConditionValue:
type: object
properties:
type:
type: string
enum:
- SOQL_STRING
- SOQL_ID
- SOQL_DATETIME
- SOQL_BOOLEAN
- SOQL_OTHER
value:
type: string
SalesforceObject:
type: object
properties:
type:
type: string
enum:
- SERVICE_CLOUD
- CHATTER
- CONTENT
- KNOWLEDGEBASE
- CUSTOM
name:
type: string
label:
type: string
indexed:
type: boolean
filesIndexed:
type: boolean
canHaveFiles:
type: boolean
custom:
type: boolean
hasCustomFiletype:
type: boolean
fields:
type: array
items:
$ref: '#/components/schemas/SalesforceField'
relationships:
type: array
items:
$ref: '#/components/schemas/SalesforceRelationship'
conditions:
type: array
items:
$ref: '#/components/schemas/SalesforceCondition'
searchable:
type: boolean
categories:
type: array
items:
type: string
enum:
- SERVICE_CLOUD
- EXPERIENCE_CLOUD
- KNOWLEDGE
- CUSTOM_OBJECT
- STANDARD
- CHATTER
SalesforceRelationship:
type: object
properties:
relationshipName:
type: string
relationshipType:
type: string
enum:
- NON_POLYMORPHIC_PARENT
- POLYMORPHIC_PARENT
- CHILD
referenceField:
type: string
referencesTo:
type: array
items:
type: string
fields:
type: array
items:
$ref: '#/components/schemas/SalesforceField'
conditions:
type: array
items:
$ref: '#/components/schemas/SalesforceCondition'
createRecord:
type: boolean
SalesforceSitesSourceModel:
type: object
allOf:
- $ref: '#/components/schemas/SourceModel'
- type: object
properties:
username:
type: string
password:
type: string
hasPassword:
type: boolean
alwaysTrustCertificates:
type: boolean
enableJavaScript:
type: boolean
indexJsonLdMetadata:
type: boolean
formAuthenticationConfig:
$ref: '#/components/schemas/FormAuthenticationConfig'
includeShadowDom:
type: boolean
javaScriptLoadingDelayInMilliseconds:
type: integer
format: int32
requestsTimeoutInSeconds:
type: integer
format: int32
scrapingMatchingStrategy:
type: string
scrapingConfiguration:
type: string
userAgent:
type: string
urls:
type: array
items:
type: string
indexExternalPages:
type: boolean
indexExternalPagesLinks:
type: boolean
respectRobotsDotTxt:
type: boolean
respectAnchorNoFollow:
type: boolean
respectMetaNoFollow:
type: boolean
respectNoIndexTag:
type: boolean
respectUrlCasing:
type: boolean
indexSubdomains:
type: boolean
maxAutoRedirects:
type: integer
format: int32
maxCrawlDepth:
type: integer
format: int32
maxPageSizeInBytes:
type: integer
format: int32
maxRequestsRetryCount:
type: integer
format: int32
minCrawlDelayInMilliseconds:
type: integer
format: int32
requestsRetryDelayInMilliseconds:
type: integer
format: int32
queryParamsToIgnore:
type: array
items:
type: string
salesforceOrg:
type: string
salesforceUser:
type: string
sandbox:
type: boolean
oauthRefreshTokenGuid:
type: string
oauthRefreshToken:
type: string
SalesforceSourceModel:
type: object
allOf:
- $ref: '#/components/schemas/SourceModel'
- type: object
properties:
sandbox:
type: boolean
salesforceOrg:
type: string
getoAuthRefreshToken:
type: string
getoAuthRefreshTokenGuid:
type: string
urls:
type: array
items:
type: string
salesforceUser:
type: string
salesforceUserId:
type: string
salesforceOrgName:
type: string
schemaVersion:
type: string
enum:
- CLOUDV1
- LEGACY
- EXPRESS
getoAuthAccessToken:
type: string
idUrl:
type: string
instanceUrl:
type: string
serviceCloudAvailable:
type: boolean
knowledgeAvailable:
type: boolean
contentAvailable:
type: boolean
chatterAvailable:
type: boolean
cloudCrazeProductsAvailable:
type: boolean
cloudCrazeOrdersAvailable:
type: boolean
organizationId:
type: string
serviceCloudIndexed:
type: boolean
knowledgeIndexed:
type: boolean
contentIndexed:
type: boolean
chatterIndexed:
type: boolean
cloudCrazeProductsIndexed:
type: boolean
cloudCrazeOrdersIndexed:
type: boolean
objectsToGet:
type: array
items:
$ref: '#/components/schemas/SalesforceObject'
SecurityIdentityInfoModel:
type: object
properties:
key:
type: string
value:
type: string
ServiceNowSourceModel:
type: object
allOf:
- $ref: '#/components/schemas/SourceModel'
- type: object
properties:
username:
type: string
password:
type: string
hasPassword:
type: boolean
instanceUrl:
type: string
clientId:
type: string
clientSecret:
type: string
clientSecretGuid:
type: string
passwordGuid:
type: string
objectsToGetConfiguration:
type: string
genericObjectsToGetConfiguration:
type: string
oauthRefreshTokenGuid:
type: string
oauthRefreshToken:
type: string
SharePointOnline2SourceModel:
type: object
allOf:
- $ref: '#/components/schemas/SourceModel'
- type: object
properties:
refreshToken:
type: string
refreshTokenGuid:
type: string
certificate:
type: string
certificatePassword:
type: string
hasCertificate:
type: boolean
hasCertificatePassword:
type: boolean
urls:
type: array
items:
type: string
tenantName:
type: string
crawlingAccount:
type: string
loadUserProfiles:
type: boolean
loadPersonalSites:
type: boolean
indexFolders:
type: boolean
indexDraftItems:
type: boolean
indexAllSiteCollections:
type: boolean
indexHubSites:
type: boolean
isOneDriveMode:
type: boolean
listTypesToIgnore:
type: array
items:
type: string
hubSitesToIndex:
type: array
items:
type: string
useSelectedSitesList:
type: boolean
tenantId:
type: string
clientId:
type: string
exclusionCondition:
type: string
itemsModificationPeriod:
$ref: '#/components/schemas/ItemsModificationPeriod'
excludeDisabledUserProfiles:
type: boolean
SharePointSourceModel:
type: object
allOf:
- $ref: '#/components/schemas/SourceModel'
- type: object
properties:
username:
type: string
password:
type: string
hasPassword:
type: boolean
activeDirectoryUsername:
type: string
activeDirectoryPassword:
type: string
hasActiveDirectoryPassword:
type: boolean
activeDirectoryEmailAttributes:
type: array
items:
type: string
activeDirectoryExpandTrustedDomains:
type: boolean
activeDirectoryExpandWellKnowns:
type: boolean
activeDirectoryTlsMode:
type: string
useActiveDirectoryPermissions:
type: boolean
hasExpandedSecurityProvider:
type: boolean
urls:
type: array
items:
type: string
crawlScope:
type: string
authenticationType:
type: string
loadUserProfiles:
type: boolean
loadPersonalSites:
type: boolean
indexListFolders:
type: boolean
adfsServerUrl:
type: string
sharePointTrustIdentifier:
type: string
oktaRealm:
type: string
oktaSignInUrl:
type: string
ignoreUnchangedSiteCollections:
type: boolean
reindexOnUpdateShallow:
type: boolean
useEnhancedIncrementalRefresh:
type: boolean
useCommonClaimsProvider:
type: boolean
ShopifySourceModel:
type: object
allOf:
- $ref: '#/components/schemas/SourceModel'
- type: object
properties:
shopId:
type: string
productFeedId:
type: string
fullSyncId:
type: string
accessToken:
type: string
shopDomain:
type: string
productMetafields:
type: array
items:
$ref: '#/components/schemas/MetafieldConfiguration'
variantMetafields:
type: array
items:
$ref: '#/components/schemas/MetafieldConfiguration'
fetchUnitCost:
type: boolean
SinglePermissionModel:
type: object
properties:
allowed:
type: boolean
identityType:
type: string
enum:
- USER
- GROUP
- VIRTUAL_GROUP
- UNKNOWN
identity:
type: string
securityProvider:
type: string
additionalInfo:
type: object
additionalProperties:
type: string
lastUpdateDate:
type: string
format: date-time
lastUpdateResult:
type: string
enum:
- NONE
- SUCCESS
- ACCESS_DENIED
- TIMED_OUT
- ENTITY_IS_INVALID
- ENTITY_IS_UNAVAILABLE
- SECURITY_PROVIDER_IS_UNAVAILABLE
- SECURITY_PROVIDER_IS_UNREACHABLE
- SECURITY_PROVIDER_IS_NOT_READY
- UNEXPECTED_ERROR
lastUpdateErrorDetail:
type: string
state:
type: string
enum:
- UNKNOWN
- UP_TO_DATE
- NOT_UPDATED
- OUT_OF_DATE
- IN_ERROR
- DISABLED
SitecoreSourceModel:
type: object
allOf:
- $ref: '#/components/schemas/SourceModel'
SitemapSourceModel:
type: object
allOf:
- $ref: '#/components/schemas/SourceModel'
- type: object
properties:
username:
type: string
password:
type: string
hasPassword:
type: boolean
alwaysTrustCertificates:
type: boolean
enableJavaScript:
type: boolean
indexJsonLdMetadata:
type: boolean
formAuthenticationConfig:
$ref: '#/components/schemas/FormAuthenticationConfig'
includeShadowDom:
type: boolean
javaScriptLoadingDelayInMilliseconds:
type: integer
format: int32
requestsTimeoutInSeconds:
type: integer
format: int32
scrapingMatchingStrategy:
type: string
scrapingConfiguration:
type: string
userAgent:
type: string
urls:
type: array
items:
type: string
requestsIntervalInMs:
type: integer
format: int32
SlackSourceModel:
type: object
allOf:
- $ref: '#/components/schemas/SourceModel'
- type: object
properties:
username:
type: string
password:
type: string
hasPassword:
type: boolean
accessToken:
type: string
maskedAccessToken:
type: string
accessTokenWorkspace:
type: string
accessTokenGuid:
type: string
exportDataUrl:
type: string
oldestMessageInDays:
type: integer
format: int32
oldestMessageTimestampInSeconds:
type: integer
format: int64
indexChannels:
type: boolean
indexPrivateChannels:
type: boolean
includeDeletedAndDisabledUsers:
type: boolean
indexFilesAndAttachments:
type: boolean
indexUsers:
type: boolean
ignoreBotMessages:
type: boolean
channelsToGet:
type: string
SourceExtensionModel:
type: object
properties:
actionOnError:
type: string
description: 'The action to carry out when the [extension](https://docs.coveo.com/en/206/) returns an error.
See [Action on error](https://docs.coveo.com/en/1943/#actionOnError).
**Allowed values:**
- `REJECT_DOCUMENT`:
The item is rejected (i.e., it is not indexed).
- `SKIP_EXTENSION`: The item continues to be processed in
the indexing pipeline, as if the extension had never been applied.
**Default:** `SKIP_EXTENSION`
'
enum:
- REJECT_DOCUMENT
- SKIP_EXTENSION
condition:
type: string
description: The condition the [item](https://docs.coveo.com/en/210/) must meet for the [extension](https://docs.coveo.com/en/206/)
to apply to it.
See [Indexing Pipeline Extension Condition Syntax Reference](https://docs.coveo.com/en/64/).
**Example:** `%[ytlikecount] OR %[ytdislikecount]`
**Default:** `""`
extensionId:
type: string
description: The unique identifier of the [extension](https://docs.coveo.com/en/206/) to apply.
**Example:**
`mycoveocloudv2organizationg8tp8wu3-vwlyqfbtjkotxqkmrxqjcbcpoy`
itemType:
type: string
description: The type of item to apply the [extension](https://docs.coveo.com/en/206/) to, in the case of an extension
only applying to a specific item type.
**Note:** Typically matches the key of the extension configuration.
**Example:** `Video`
parameters:
type: object
additionalProperties:
type: string
description: Additional parameters to pass to the [extension](https://docs.coveo.com/en/206/).
See [Pass
parameters](https://docs.coveo.com/en/1943/#Parameters).
**Example:** `{"myparam":38}`
**Default:**
`{}`
description: Additional parameters to pass to the [extension](https://docs.coveo.com/en/206/).
See [Pass parameters](https://docs.coveo.com/en/1943/#Parameters).
**Example:** `{"myparam":38}`
**Default:** `{}`
versionId:
type: string
description: The unique identifier of the [extension](https://docs.coveo.com/en/206/) version to execute.
See
[Execute a specific extension version](https://docs.coveo.com/en/1943/#Version).
**Example**:`hdJSDb4hTkdnsCynNtF.d657FgLSDydcj`
By default, the latest extension version is used.
description: An [extension](https://docs.coveo.com/en/206/) configuration.
SourceInformation:
type: object
properties:
sourceStatus:
$ref: '#/components/schemas/SourceStatus'
lastOperation:
$ref: '#/components/schemas/SourceLastOperation'
nextOperation:
$ref: '#/components/schemas/NextOperation'
rebuildRequired:
type: boolean
rebuildRequiredReasons:
type: array
items:
type: string
enum:
- SOURCE_CONFIGURATION_UPDATED
- FIELD_CONFIGURATION_UPDATED
numberOfDocuments:
type: integer
format: int64
deprecated: true
documentsTotalSize:
type: integer
format: int64
lastRefreshEndDate:
type: string
format: date-time
lastRebuildEndDate:
type: string
format: date-time
lastFullRefreshEndDate:
type: string
format: date-time
lastIncrementalRefreshEndDate:
type: string
format: date-time
SourceLastOperation:
type: object
properties:
id:
type: string
operationType:
type: string
enum:
- REBUILD
- FULL_REFRESH
- INCREMENTAL_REFRESH
- SECURITY_PROVIDER_REFRESH
- SECURITY_PROVIDER_REFRESH_ENTITIES_IN_ERROR
- SECURITY_PROVIDER_REFRESH_ENTITIES_NOT_UPDATED
- SECURITY_CACHE_REFRESH
- SECURITY_CACHE_REFRESH_ENTITIES_IN_ERROR
timestamp:
type: string
format: date-time
result:
type: string
errorCode:
type: string
initialBuild:
type: boolean
numberOfDocuments:
type: integer
format: int64
numberOfAddedDocuments:
type: integer
format: int64
numberOfFilteredDocuments:
type: integer
format: int64
numberOfRemovedDocuments:
type: integer
format: int64
numberOfUnchangedDocuments:
type: integer
format: int64
numberOfUpdatedDocuments:
type: integer
format: int64
startedDate:
type: string
format: date-time
SourceModel:
type: object
properties:
groupsThatCanEdit:
uniqueItems: true
type: array
items:
$ref: '#/components/schemas/IdAndDisplayNameModel'
apiKeysThatCanEdit:
uniqueItems: true
type: array
items:
$ref: '#/components/schemas/IdAndDisplayNameModel'
projectIds:
type: array
items:
type: string
sourceType:
type: string
enum:
- AMAZONS3
- BOX_ENTERPRISE2
- CATALOG
- CONFLUENCE2
- CONFLUENCE2_HOSTED
- CUSTOM
- DATABASE
- DROPBOX_FOR_BUSINESS
- FILE
- GENERIC_REST
- GOOGLE_DRIVE_DOMAIN_WIDE
- GRAPHQL
- JIRA2
- JIRA2_HOSTED
- JIVE
- JIVE_HOSTED
- LITHIUM
- KHOROS
- MICROSOFT_DYNAMICS
- PUSH
- RSS
- SALESFORCE
- SALESFORCE_SITES
- SAP
- SERVICENOW
- SHAREPOINT
- SHAREPOINT_ONLINE2
- SHOPIFY
- SITECORE
- SITEMAP
- SLACK
- WEB2
- YOUTUBE
- ZENDESK
- ADOBE_EXPERIENCE_MANAGER
- BOX
- BOX_ENTERPRISE
- CONFLUENCE
- DROPBOX
- GMAIL
- GMAIL_DOMAIN_WIDE
- SHAREPOINT_ONLINE
id:
type: string
name:
type: string
owner:
type: string
lastModifier:
type: string
lastModifiedDate:
type: string
format: date-time
createdDate:
type: string
format: date-time
sourceVisibility:
type: string
enum:
- PRIVATE
- SECURED
- SHARED
customParameters:
type: object
additionalProperties:
type: string
mappings:
type: array
items:
$ref: '#/components/schemas/MappingModel'
documentConfig:
$ref: '#/components/schemas/DocumentConfig'
information:
$ref: '#/components/schemas/SourceInformation'
configurationError:
$ref: '#/components/schemas/ConfigurationError'
pushEnabled:
type: boolean
onPremisesEnabled:
type: boolean
streamEnabled:
type: boolean
logicalIndex:
type: string
crawlingModuleId:
type: string
pendingCrawlingModuleId:
type: string
securityProviderReferences:
uniqueItems: true
type: array
items:
type: string
preConversionExtensions:
type: array
items:
$ref: '#/components/schemas/SourceExtensionModel'
postConversionExtensions:
type: array
items:
$ref: '#/components/schemas/SourceExtensionModel'
permissions:
$ref: '#/components/schemas/DocumentPermissionModel'
urlFilters:
type: array
items:
$ref: '#/components/schemas/UrlFilter'
ocrFileTypes:
type: array
items:
type: string
resourceId:
type: string
discriminator:
propertyName: sourceType
SourceStatus:
type: object
properties:
type:
type: string
enum:
- CREATING
- DISABLED
- REFRESHING
- PAUSED
- PAUSED_ON_ERROR
- IDLE
- ERROR
- PUSH_READY
refreshType:
type: string
enum:
- REBUILD
- FULL_REFRESH
- INCREMENTAL_REFRESH
- SECURITY_PROVIDER_REFRESH
- SECURITY_PROVIDER_REFRESH_ENTITIES_IN_ERROR
- SECURITY_PROVIDER_REFRESH_ENTITIES_NOT_UPDATED
- SECURITY_CACHE_REFRESH
- SECURITY_CACHE_REFRESH_ENTITIES_IN_ERROR
numberOfProcessedDocuments:
type: integer
format: int64
timestamp:
type: string
format: date-time
pausedOnErrorCode:
type: string
allowedOperations:
type: array
items:
type: string
enum:
- APPLY
- ARCHIVE
- ARCHIVE_WARNING
- BACKUP
- CHANGE_ONLINE
- CHANGE_READ_ONLY
- COMMIT
- CONFIG_CHANGE
- CONFIG_CREATE
- CREATE
- DECLINE
- DELETE
- DISABLE
- DUPLICATE
- ENABLE
- ENABLE_DISABLED_ENTITIES
- EXPORT
- FULL_REFRESH
- HORIZONTAL_SCALING
- IDLE
- IMPORT
- INCREMENTAL_REFRESH
- LIMIT_ALMOST_REACHED
- LIMIT_EXCEEDED
- LIMIT_REACHED
- LOG_REQUEST
- METADATA_REPORT
- MODEL_BUILD
- MODEL_REFRESH
- ORG_PROVISIONING_CHECK
- PAUSE
- PAUSE_ON_ERROR
- REBUILD
- REFRESH
- REFRESH_CANCEL
- REFRESH_ENTITIES_IN_ERROR
- REFRESH_ENTITIES_NOT_UPDATED
- REFRESH_ENTITY
- REMEDIATE
- RESIZE
- RESTORE
- RESUME
- ROTATE
- SCHEDULE_CHANGE
- SCHEDULE_CREATE
- SCHEDULE_DELETE
- SEARCH_CERTIFICATE_UPDATE
- SEARCH_INCIDENT
- SEND_RESOURCE_SNAPSHOT
- START
- STOP
- SYNCHRONIZE
- TEST
- UPDATE
- UPGRADE
- UPGRADE_REVERT
- VALIDATE
- VERTICAL_SCALING
extendedCurrentStatus:
type: string
enum:
- CREATING
- DISABLED
- STARTING_REFRESH
- REFRESHING
- PAUSING
- PAUSED
- RESUMING
- CANCELING
- PAUSED_ON_ERROR
- IDLE
- ERROR
- PUSH_READY
- DELETING
numberOfAddedDocuments:
type: integer
format: int64
numberOfFilteredDocuments:
type: integer
format: int64
numberOfRemovedDocuments:
type: integer
format: int64
numberOfUnchangedDocuments:
type: integer
format: int64
numberOfUpdatedDocuments:
type: integer
format: int64
statusMessage:
type: string
activityId:
type: string
createdDate:
type: string
format: date-time
initialBuild:
type: boolean
numberOfDocuments:
type: integer
format: int64
deprecated: true
UrlFilter:
type: object
properties:
filter:
type: string
includeFilter:
type: boolean
filterType:
type: string
enum:
- WILDCARD
- REGEX
Web2SourceModel:
type: object
allOf:
- $ref: '#/components/schemas/SourceModel'
- type: object
properties:
username:
type: string
password:
type: string
hasPassword:
type: boolean
alwaysTrustCertificates:
type: boolean
enableJavaScript:
type: boolean
indexJsonLdMetadata:
type: boolean
formAuthenticationConfig:
$ref: '#/components/schemas/FormAuthenticationConfig'
includeShadowDom:
type: boolean
javaScriptLoadingDelayInMilliseconds:
type: integer
format: int32
requestsTimeoutInSeconds:
type: integer
format: int32
scrapingMatchingStrategy:
type: string
scrapingConfiguration:
type: string
userAgent:
type: string
urls:
type: array
items:
type: string
indexExternalPages:
type: boolean
indexExternalPagesLinks:
type: boolean
respectRobotsDotTxt:
type: boolean
respectAnchorNoFollow:
type: boolean
respectMetaNoFollow:
type: boolean
respectNoIndexTag:
type: boolean
respectUrlCasing:
type: boolean
indexSubdomains:
type: boolean
maxAutoRedirects:
type: integer
format: int32
maxCrawlDepth:
type: integer
format: int32
maxPageSizeInBytes:
type: integer
format: int32
maxRequestsRetryCount:
type: integer
format: int32
minCrawlDelayInMilliseconds:
type: integer
format: int32
requestsRetryDelayInMilliseconds:
type: integer
format: int32
queryParamsToIgnore:
type: array
items:
type: string
YouTubeSourceModel:
type: object
allOf:
- $ref: '#/components/schemas/SourceModel'
- type: object
properties:
urls:
type: array
items:
type: string
indexPlaylists:
type: boolean
ZendeskSourceModel:
type: object
allOf:
- $ref: '#/components/schemas/SourceModel'
- type: object
properties:
accessToken:
type: string
accessTokenGuid:
type: string
refreshToken:
type: string
refreshTokenGuid:
type: string
indexAdministrationEntities:
type: boolean
indexArticles:
type: boolean
indexArticleTranslations:
type: boolean
indexComments:
type: boolean
indexTickets:
type: boolean
indexAttachments:
type: boolean
indexAgentsAndAdministratorsPermissionsOnly:
type: boolean
indexSpecificOrganizationsPermissions:
type: string
urls:
type: array
items:
type: string
indexArchivedTickets:
type: boolean
indexDeletedTickets:
type: boolean
zendeskLocale:
type: string
indexTicketsByOrganization:
type: string
indexTicketsByTags:
type: string
crawlingAccount:
type: string
HourMinutePair:
type: object
properties:
hour:
type: integer
format: int32
minute:
type: integer
format: int32
ScheduleFrequency:
type: object
properties:
type:
type: string
enum:
- MINUTELY
- HOURLY
- DAILY
- WEEKLY
- MONTHLY
value:
type: integer
format: int32
hourMinute:
$ref: '#/components/schemas/HourMinutePair'
monthDay:
type: integer
format: int32
weekDays:
type: array
items:
type: string
enum:
- MONDAY
- TUESDAY
- WEDNESDAY
- THURSDAY
- FRIDAY
- SATURDAY
- SUNDAY
seed:
type: integer
format: int32
ScheduleModel:
type: object
properties:
id:
type: string
refreshType:
type: string
enum:
- REBUILD
- FULL_REFRESH
- INCREMENTAL_REFRESH
- SECURITY_PROVIDER_REFRESH
- SECURITY_PROVIDER_REFRESH_ENTITIES_IN_ERROR
- SECURITY_PROVIDER_REFRESH_ENTITIES_NOT_UPDATED
- SECURITY_CACHE_REFRESH
- SECURITY_CACHE_REFRESH_ENTITIES_IN_ERROR
scheduleType:
type: string
enum:
- SECURITY_CACHE
- SECURITY_PROVIDER
- SOURCE
enabled:
type: boolean
frequency:
$ref: '#/components/schemas/ScheduleFrequency'
organizationId:
type: string
resourceId:
type: string
lastExecution:
type: string
format: date-time
AddressPattern:
type: object
properties:
expression:
type: string
patternType:
type: string
enum:
- Wildcard
- RegEx
allowed:
type: boolean
CascadingSecurityProvider:
type: object
properties:
id:
type: string
name:
type: string
type:
type: string
deprecated: true
enum:
- ACTIVE_DIRECTORY2
- BOX
- CLAIMS
- CLAIMS_TO_EMAIL
- CONFLUENCE
- CONFLUENCE2
- CUSTOM
- DATABASE
- DROPBOX_FOR_BUSINESS
- EMAIL
- EXPANDED
- FILE
- GOOGLE_DRIVE_DOMAIN_WIDE
- GENERIC_REST
- GRAPHQL
- JIRA2
- JIVE
- KHOROS_COMMUNITY
- MICROSOFT_DYNAMICS
- OFFICE365
- SALESFORCE
- SERVICENOW
- SHAREPOINT
- SHAREPOINT_ONLINE
- SITECORE
- SLACK
- ZENDESK
typeName:
type: string
DataFile:
type: object
properties:
sensitive:
type: boolean
data:
type: string
ExtendedConfig:
type: object
properties:
documentConsumerURI:
type: string
indexIdentifier:
type: string
dbConnectionString:
type: string
reportingServiceUri:
type: string
sourceInformation:
$ref: '#/components/schemas/SourceInformation'
sourceSecurityOption:
type: string
enum:
- Retrieve
- Specified
- Merge
startingAddresses:
type: array
items:
type: string
addressPatterns:
type: array
items:
$ref: '#/components/schemas/AddressPattern'
permissions:
type: array
items:
$ref: '#/components/schemas/PermissionLevel'
parameters:
type: object
additionalProperties:
$ref: '#/components/schemas/Parameter'
securityProviders:
type: object
additionalProperties:
$ref: '#/components/schemas/SecurityProvider'
userIdentities:
type: object
additionalProperties:
$ref: '#/components/schemas/UserIdentity'
dataFiles:
type: object
additionalProperties:
$ref: '#/components/schemas/DataFile'
caseSensitivePatterns:
type: boolean
documentConfig:
$ref: '#/components/schemas/DocumentConfig'
extendedDataFiles:
type: object
additionalProperties:
$ref: '#/components/schemas/ExtendedDataFile'
ExtendedDataFile:
type: object
properties:
sensitive:
type: boolean
data:
type: string
extendedData:
type: object
Parameter:
type: object
properties:
sensitive:
type: boolean
value:
type: string
ParameterModel:
type: object
properties:
value:
type: string
sensitive:
type: boolean
Permission:
type: object
properties:
identityType:
type: string
enum:
- Unknown
- User
- Group
- VirtualGroup
securityProvider:
type: string
identity:
type: string
additionalInfo:
type: object
additionalProperties:
type: string
PermissionLevel:
type: object
properties:
permissionSets:
type: array
items:
$ref: '#/components/schemas/PermissionSet'
name:
type: string
PermissionSet:
type: object
properties:
allowAnonymous:
type: boolean
allowedPermissions:
type: array
items:
$ref: '#/components/schemas/Permission'
deniedPermissions:
type: array
items:
$ref: '#/components/schemas/Permission'
name:
type: string
RawSourceConfig:
type: object
properties:
groupsThatCanEdit:
uniqueItems: true
type: array
items:
$ref: '#/components/schemas/IdAndDisplayNameModel'
apiKeysThatCanEdit:
uniqueItems: true
type: array
items:
$ref: '#/components/schemas/IdAndDisplayNameModel'
id:
type: string
name:
type: string
owner:
type: string
lastModifier:
type: string
lastModifiedDate:
type: string
format: date-time
createdDate:
type: string
format: date-time
sourceType:
type: string
enum:
- AMAZONS3
- BOX_ENTERPRISE2
- CATALOG
- CONFLUENCE2
- CONFLUENCE2_HOSTED
- CUSTOM
- DATABASE
- DROPBOX_FOR_BUSINESS
- FILE
- GENERIC_REST
- GOOGLE_DRIVE_DOMAIN_WIDE
- GRAPHQL
- JIRA2
- JIRA2_HOSTED
- JIVE
- JIVE_HOSTED
- LITHIUM
- KHOROS
- MICROSOFT_DYNAMICS
- PUSH
- RSS
- SALESFORCE
- SALESFORCE_SITES
- SAP
- SERVICENOW
- SHAREPOINT
- SHAREPOINT_ONLINE2
- SHOPIFY
- SITECORE
- SITEMAP
- SLACK
- WEB2
- YOUTUBE
- ZENDESK
- ADOBE_EXPERIENCE_MANAGER
- BOX
- BOX_ENTERPRISE
- CONFLUENCE
- DROPBOX
- GMAIL
- GMAIL_DOMAIN_WIDE
- SHAREPOINT_ONLINE
crawlerInstanceType:
type: string
additionalInfos:
type: object
additionalProperties:
type: object
configuration:
$ref: '#/components/schemas/ExtendedConfig'
preConversionExtensions:
type: array
items:
$ref: '#/components/schemas/SourceExtensionModel'
postConversionExtensions:
type: array
items:
$ref: '#/components/schemas/SourceExtensionModel'
mappings:
type: array
items:
$ref: '#/components/schemas/MappingModel'
securityProviders:
type: array
items:
$ref: '#/components/schemas/SecurityProviderModel'
securityProviderReferences:
uniqueItems: true
type: array
items:
type: string
additionalComments:
type: string
crawlingModuleId:
type: string
fromRaw:
type: boolean
pushEnabled:
type: boolean
onPremisesEnabled:
type: boolean
streamEnabled:
type: boolean
logicalIndex:
type: string
performFieldMappingUsingAllOrigins:
type: boolean
resourceId:
type: string
SecurityProvider:
type: object
properties:
name:
type: string
typeName:
type: string
SecurityProviderModel:
type: object
properties:
id:
type: string
name:
type: string
displayName:
type: string
organizationId:
type: string
type:
type: string
enum:
- ACTIVE_DIRECTORY2
- BOX
- CLAIMS
- CLAIMS_TO_EMAIL
- CONFLUENCE
- CONFLUENCE2
- CUSTOM
- DATABASE
- DROPBOX_FOR_BUSINESS
- EMAIL
- EXPANDED
- FILE
- GOOGLE_DRIVE_DOMAIN_WIDE
- GENERIC_REST
- GRAPHQL
- JIRA2
- JIVE
- KHOROS_COMMUNITY
- MICROSOFT_DYNAMICS
- OFFICE365
- SALESFORCE
- SERVICENOW
- SHAREPOINT
- SHAREPOINT_ONLINE
- SITECORE
- SLACK
- ZENDESK
nodeTypeName:
type: string
sourceTypeName:
type: string
nodeRequired:
type: boolean
onPremisesEnabled:
type: boolean
projectIds:
type: array
items:
type: string
crawlingModuleId:
type: string
caseSensitive:
type: boolean
userIdentities:
type: object
additionalProperties:
$ref: '#/components/schemas/UserIdentityModel'
parameters:
type: object
additionalProperties:
$ref: '#/components/schemas/ParameterModel'
cascadingSecurityProviders:
type: object
additionalProperties:
$ref: '#/components/schemas/CascadingSecurityProvider'
referencedBy:
type: array
items:
$ref: '#/components/schemas/SecurityProviderReferenceModel'
instanceId:
type: string
SecurityProviderReferenceModel:
type: object
properties:
type:
type: string
enum:
- SOURCE
- SECURITY_PROVIDER
id:
type: string
attributes:
type: object
UserIdentity:
type: object
properties:
name:
type: string
userName:
type: string
password:
type: string
UserIdentityModel:
type: object
properties:
name:
type: string
username:
type: string
password:
type: string
PermissionModel:
type: object
properties:
permissionLevels:
type: array
items:
$ref: '#/components/schemas/PermissionLevel'
SourcePermissionsUpdateModel:
type: object
properties:
permissionBehavior:
type: string
enum:
- UseCrawler
- Override
- Merge
permissions:
$ref: '#/components/schemas/PermissionModel'
CommonMappingSettingsModel:
type: object
properties:
rules:
type: array
description: The [mapping](https://docs.coveo.com/en/217/) rules.
See [Mapping Rule Syntax Reference](https://docs.coveo.com/en/1839/).
items:
$ref: '#/components/schemas/RuleModel'
description: A JSON describing the common [mappings](https://docs.coveo.com/en/217/) to update.
MappingsConfigurationModel:
type: object
properties:
common:
$ref: '#/components/schemas/CommonMappingSettingsModel'
types:
type: array
description: The specific [mappings](https://docs.coveo.com/en/217/) (i.e., the mappings that apply only to specified
[item](https://docs.coveo.com/en/210/) types).
items:
$ref: '#/components/schemas/TypedMappingSettingsModel'
description: A JSON describing the [mapping](https://docs.coveo.com/en/217/) configuration to add or update.
RuleModel:
type: object
properties:
field:
type: string
description: The name of the target [field](https://docs.coveo.com/en/200/) to populate with the first non-null
value yielded by a mapping rule statement from the `content` array.
**Example:** `rating`
content:
type: array
description: The mapping rule statements.
**Example:** `["%[internal_rating]"]`
See [Mapping Rule Syntax
Reference](https://docs.coveo.com/en/1839/).
items:
type: string
description: The mapping rule statements.
**Example:** `["%[internal_rating]"]`
See [Mapping Rule Syntax
Reference](https://docs.coveo.com/en/1839/).
id:
type: string
description: The unique identifier of the mapping rule.
**Example:** `q5dpywnbpb3ul7xpyodh3e2j7i`
description: 'A [mapping](https://docs.coveo.com/en/217/) rule.
See [Mapping Definition Examples](https://docs.coveo.com/en/66/).'
TypedMappingSettingsModel:
type: object
properties:
rules:
type: array
description: The [mapping](https://docs.coveo.com/en/217/) rules.
See [Mapping Rule Syntax Reference](https://docs.coveo.com/en/1839/).
items:
$ref: '#/components/schemas/RuleModel'
type:
type: string
description: The type of [item](https://docs.coveo.com/en/210/) for which the mapping applies.
**Example:**
`Video`
id:
type: string
description: The unique identifier of the mapping.
**Note:** Typically matches the `type` value.
**Example:**
`Video`
description: A specific [mapping](https://docs.coveo.com/en/217/) (i.e., a mapping that applies only to a specified
[item](https://docs.coveo.com/en/210/) type).
BaseRuleModel:
type: object
properties:
field:
type: string
description: The name of the target [field](https://docs.coveo.com/en/200/) to populate with the first non-null
value yielded by a mapping rule statement from the `content` array.
**Example:** `rating`
content:
type: array
description: The mapping rule statements.
**Example:** `["%[internal_rating]"]`
See [Mapping Rule Syntax
Reference](https://docs.coveo.com/en/1839/).
items:
type: string
description: The mapping rule statements.
**Example:** `["%[internal_rating]"]`
See [Mapping Rule Syntax
Reference](https://docs.coveo.com/en/1839/).
description: The common [mapping](https://docs.coveo.com/en/217/) rule to create.
BaseTypedMappingSettingsModelBaseRuleModel:
type: object
properties:
rules:
type: array
description: The [mapping](https://docs.coveo.com/en/217/) rules.
See [Mapping Rule Syntax Reference](https://docs.coveo.com/en/1839/).
items:
$ref: '#/components/schemas/BaseRuleModel'
type:
type: string
description: The type of [item](https://docs.coveo.com/en/210/) for which the mapping applies.
**Example:**
`Video`
description: A JSON describing the specific [mapping](https://docs.coveo.com/en/217/) to create.
SourceExtensionsMap:
type: object
properties:
common:
$ref: '#/components/schemas/SourceExtensionsModel'
items:
type: object
additionalProperties:
$ref: '#/components/schemas/SourceExtensionsModel'
description: 'The [extension](https://docs.coveo.com/en/206/) configurations that apply to specific [item](https://docs.coveo.com/en/210/)
types. The key is the item type, and the value object describes the extension configurations.
**Example:**
`{"Video":{"postConversionExtensions":[{"extensionId": "mycoveocloudv2organizationg8tp8wu3-vwlyqfbtjkotxqkmrxqjcbcpoy"}]}}`'
description: The [extension](https://docs.coveo.com/en/206/) configurations to set on the target [source](https://docs.coveo.com/en/246/).
SourceExtensionsModel:
type: object
properties:
preConversionExtensions:
type: array
description: The postconversion [extension](https://docs.coveo.com/en/206/) configurations.
See [Preconversion
Versus Postconversion](https://docs.coveo.com/en/1556/#PreVsPost).
items:
$ref: '#/components/schemas/SourceExtensionModel'
postConversionExtensions:
type: array
description: The preconversion [extension](https://docs.coveo.com/en/206/) configurations.
See [Preconversion
Versus Postconversion](https://docs.coveo.com/en/1556/#PreVsPost).
items:
$ref: '#/components/schemas/SourceExtensionModel'
description: A set of [extension](https://docs.coveo.com/en/206/) configurations.
FieldMappingModel:
type: object
properties:
sourceId:
type: string
sourceName:
type: string
mappings:
type: array
items:
$ref: '#/components/schemas/MappingModel'
LightSourceModel:
type: object
properties:
id:
type: string
name:
type: string
sourceType:
type: string
enum:
- AMAZONS3
- BOX_ENTERPRISE2
- CATALOG
- CONFLUENCE2
- CONFLUENCE2_HOSTED
- CUSTOM
- DATABASE
- DROPBOX_FOR_BUSINESS
- FILE
- GENERIC_REST
- GOOGLE_DRIVE_DOMAIN_WIDE
- GRAPHQL
- JIRA2
- JIRA2_HOSTED
- JIVE
- JIVE_HOSTED
- LITHIUM
- KHOROS
- MICROSOFT_DYNAMICS
- PUSH
- RSS
- SALESFORCE
- SALESFORCE_SITES
- SAP
- SERVICENOW
- SHAREPOINT
- SHAREPOINT_ONLINE2
- SHOPIFY
- SITECORE
- SITEMAP
- SLACK
- WEB2
- YOUTUBE
- ZENDESK
- ADOBE_EXPERIENCE_MANAGER
- BOX
- BOX_ENTERPRISE
- CONFLUENCE
- DROPBOX
- GMAIL
- GMAIL_DOMAIN_WIDE
- SHAREPOINT_ONLINE
crawlerInstanceType:
type: string
pushEnabled:
type: boolean
onPremisesEnabled:
type: boolean
streamEnabled:
type: boolean
SourceFieldModel:
type: object
properties:
name:
type: string
description: The name of the [field](https://docs.coveo.com/en/200/), also referred to as the field identifier,
or `fieldId`.
**Note:** Must match `^([a-z][a-z0-9_]{0,254})$`
**Example:** `date`
example: date
description:
type: string
description: A description of the [field](https://docs.coveo.com/en/200/).
**Example:** `The date of creation
of a given item`
label:
type: string
description: A displayable label for the [field](https://docs.coveo.com/en/200/) when used by the facet generator.
automaticFacetsCandidate:
type: boolean
description: Whether this [field](https://docs.coveo.com/en/200/) is to be considered by the facet generator feature.
**Default:** `false`.
example: false
default: false
automaticFacetsCandidateTags:
type: array
description: Optional list of tags that specify which properties/contexts this field should be an AFG candidate
for. An empty or null list means the field is an AFG candidate for all properties (org-wide). Tag names must be
1-64 characters and contain only alphanumeric characters (a-z, A-Z, 0-9), dots (.), hyphens (-), or underscores
(_).
**Example:** `["store1", "us.retail", "brand-name_123"]`
items:
type: string
description: Optional list of tags that specify which properties/contexts this field should be an AFG candidate
for. An empty or null list means the field is an AFG candidate for all properties (org-wide). Tag names must
be 1-64 characters and contain only alphanumeric characters (a-z, A-Z, 0-9), dots (.), hyphens (-), or underscores
(_).
**Example:** `["store1", "us.retail", "brand-name_123"]`
type:
type: string
description: The data type of the [field](https://docs.coveo.com/en/200/).
See [Field Types](https://docs.coveo.com/en/1833/#field-type).
**Allowed values:**
- `DATE`
- `LONG`
- `LONG_64`
- `DOUBLE`
- `STRING`
example: STRING
enum:
- LONG
- LONG_64
- DOUBLE
- DATE
- STRING
- VECTOR
includeInQuery:
type: boolean
description: Whether this [field](https://docs.coveo.com/en/200/) can be referred to in [Coveo Cloud query syntax](https://docs.coveo.com/en/1552/)
expressions (for example, `@myfield=myvalue`).
Coveo Atomic and Headless often rely on the fact that most
fields can be referred to in query expressions.Therefore, explicitly setting this option to `false` is not recommended,
unless you know for sure that this field is only used to return information on query results.An example where
it would make sense to set to `false` would be a field that contains large blobs of data that you want to display
in query results, but never want to search on.
**Default:** `true`
example: true
default: true
includeInResults:
type: boolean
description: Whether the [field](https://docs.coveo.com/en/200/) can be included in the `raw` property of [query](https://docs.coveo.com/en/231/)
results.
The Search API lets you explicitly specify which fields you want to include in or exclude from the
`raw` property of each result at query time.
Moreover, the [index](https://docs.coveo.com/en/204/) can include
a given field in the `raw` property of a query result only if this field has a non-null value for this particular
result.
Therefore, explicitly setting this option to `false` on a field isn't recommended, unless you want
to override this behavior and ensure that this field can never be included in the `raw` property of any query
result.
**Default:** `true`
example: true
default: true
keyValue:
type: boolean
description: Whether the field is a [dictionary field](https://docs.coveo.com/en/2036/), which contains mappings
of keys to values instead of a single value.
**Default:** `false`
example: false
default: false
multilingual:
type: boolean
description: Whether the [field](https://docs.coveo.com/en/200/) contains a mapping of languages to values instead
of a single value.
**Note:** Applicable to field type `STRING` only. This option requires the `keyValue`
option to be enabled.
**Default:** `false`
example: false
default: false
keepAccentsDisplayValueFacet:
type: boolean
description: Whether [field](https://docs.coveo.com/en/200/) values with differing accents should be considered
distinct facet values (e.g., `quebec` vs `québec`).
**Note:** Applicable to field type `STRING` only.
**Default:** `false`
example: false
default: false
keepDistinctDisplayValueFacet:
type: boolean
description: Whether [field](https://docs.coveo.com/en/200/) values with differing accents, ligatures, or casing
should be considered distinct facet values.
This parameter encompasses the behavior of **keepAccentsDisplayValueFacet**
but adds differentiation for ligatures (e.g., `ß` vs `ss`) and case sensitivity (e.g., `Québec` vs `québec`).
**Note:** Applicable to field type `STRING` only.
**Default:** `false`
example: false
default: false
mergeWithLexicon:
type: boolean
description: Whether the field is [free text searchable](https://docs.coveo.com/en/1833#free-text-search).
**Note:**
Applicable to field type `STRING` only.
**Default:** `false`
example: false
default: false
smartDateFacet:
type: boolean
description: It is heavily recommended to set this option to `false` unless you know for sure you need it.
Whether to transform date and time string values into semicolon separated number of days/weeks/months/quarters/years
since January 1st, 1900.
**Note:** Applicable to [field](https://docs.coveo.com/en/200/) type `DATE` only.
If you set this option to `true` on a `DATE` type field, the field itself will be populated by the number of
milliseconds since Unix epoch corresponding to the parsed date and time string, as usual.
However, the index
will also automatically create a new field, and populate it with the smart date data.
**Default:** `false`
Example:
You create the `mydate` field in your [index](https://docs.coveo.com/en/204/) and set the
`smartDateFacet` option to `true` on that field. The index processes a source item whose `mydate` metadata value
is `2017-11-20T19:58:55.126Z`. The `mydate` metadata is mapped to the `mydate` field in that source.
The
index populates the `mydate` field with the corresponding number of milliseconds since Unix epoch (that is, `1511207935000`).
It also creates a `mydatesmartfacet` field and populates it with the smart date data (that is, `D43057;W6151;M1414;Q471;Y117`).
example: false
default: false
facet:
type: boolean
description: Whether [Group By](https://docs.coveo.com/en/203/) operations and [Facet](https://docs.coveo.com/en/198/)
requests can be performed on the [field](https://docs.coveo.com/en/200/).
This option can't be set to `false`
on a non-`STRING` type field.
**Default:**
- `false` for `STRING` type fields.
- `true` for all
other types of fields.
example: false
multiValueFacet:
type: boolean
description: Whether the [field](https://docs.coveo.com/en/200/) contains multiple values (see also the `multiValueFacetTokenizers`
property).
**Note:** Applicable to field type `STRING` only.
**Default:** `false`
example: false
default: false
hierarchicalFacet:
type: boolean
description: Whether the [field](https://docs.coveo.com/en/200/) contains multiple values that form a hierarchy
(see also the `multiValueFacetTokenizers` property).
**Note:** Applicable to field type `STRING` only.
**Default:** `false`
example: false
default: false
sort:
type: boolean
description: Whether [query](https://docs.coveo.com/en/231/) results can be sorted based on the value of the [field](https://docs.coveo.com/en/200/).Having
lots of sortable `STRING` type fields in a Coveo organization can have an adverse effect on its [index](https://docs.coveo.com/en/204/)
size and performance.
This option can't be set to `false` on a non-`STRING` type field.
**Default:**
- `false` for `STRING` type fields.
- `true` for all other types of fields.
example: false
ranking:
type: boolean
description: Whether to use the [field](https://docs.coveo.com/en/200/) in result ranking calculation only.
**Notes:**
- Has a significant impact on query performance.
- Applicable to field type `STRING`
**Default:** `false`
example: false
default: false
stemming:
type: boolean
description: Whether to allow [stemming](https://docs.coveo.com/en/1576/) on [field](https://docs.coveo.com/en/200/)
[queries](https://docs.coveo.com/en/231/).
**Notes:**
- applicable to `STRING` type fields only.
- Has a significant impact on query performance.
**Default:** `false`
example: false
default: false
multiValueFacetTokenizers:
type: string
description: The character to use as a value separator, if the [field](https://docs.coveo.com/en/200/) contains
multiple values (see also the `multiValueFacet` property).
**Example:** `;`
example: ;
useCacheForNestedQuery:
type: boolean
description: Whether to keep the data required to perform [nested queries](https://docs.coveo.com/en/220) in memory.
Setting this option to `true` on a [field](https://docs.coveo.com/en/200/) also speeds query performance for expressions
that compare the value of this field using [regex, wildcard, phonetic match, or fuzzy match query operators](https://docs.coveo.com/en/1552).
**Note:** only applicable to fields which are faceted or multi-value faceted.
**Default:** `false`
example: false
default: false
useCacheForSort:
type: boolean
description: Whether to keep the entire [field](https://docs.coveo.com/en/200/) in memory for fast sorting.
**Default:**
`false`
This option can't be set to true on a `STRING` type field, unless the `sort` option is also `true`
for that field.
example: false
default: false
useCacheForNumericQuery:
type: boolean
description: Whether to keep the data required to execute operations on numeric and date [fields](https://docs.coveo.com/en/200/)
in memory.
**Note:** Cannot be enabled on `STRING` type fields.
**Default:** `false`
example: false
default: false
useCacheForComputedFacet:
type: boolean
description: Whether to keep computed field data in memory.
**Note:** Cannot be enabled on `STRING` type fields.
**Default:** `false`
example: false
default: false
dateFormat:
type: string
description: A regex indicating the date format, for some `date` type fields.
**Example:** `%Y/%m/%d@%H:%M:%S%G`
example: '%Y/%m/%d@%H:%M:%S%G'
system:
type: boolean
description: Whether the [field](https://docs.coveo.com/en/200/) is a standard Coveo field.
**Note:** `system`
option can not be set to `true`.
**Default:** `false`
example: false
projectIds:
type: array
description: List of Project IDs a [field](https://docs.coveo.com/en/200/) can be associated with.
**Note:**
This is an optional list of `STRING`
**Default:** `null`
items:
type: string
description: List of Project IDs a [field](https://docs.coveo.com/en/200/) can be associated with.
**Note:**
This is an optional list of `STRING`
**Default:** `null`
mappings:
type: array
items:
$ref: '#/components/schemas/FieldMappingModel'
sources:
type: array
items:
$ref: '#/components/schemas/LightSourceModel'
description: A [field](https://docs.coveo.com/en/200/).
BatchOperationProgressModelTypedMappingSettingsModel:
type: object
properties:
batchOperationId:
type: string
status:
type: string
enum:
- IN_PROGRESS
- COMPLETED
batchOperationResourcesStatus:
type: array
items:
$ref: '#/components/schemas/BatchOperationResourceStatusModelTypedMappingSettingsModel'
BatchOperationResourceStatusModelTypedMappingSettingsModel:
type: object
properties:
resourceModel:
$ref: '#/components/schemas/TypedMappingSettingsModel'
operationResult:
type: string
enum:
- SUCCESS
- ERROR
errorDetails:
type: string
successful:
type: boolean
GetSourcesOutArgs:
type: object
properties:
sourceModels:
type: array
items:
oneOf:
- $ref: '#/components/schemas/SourceModel'
- $ref: '#/components/schemas/AmazonS3SourceModel'
- $ref: '#/components/schemas/BoxEnterprise2SourceModel'
- $ref: '#/components/schemas/CatalogSourceModel'
- $ref: '#/components/schemas/Confluence2HostedSourceModel'
- $ref: '#/components/schemas/Confluence2SourceModel'
- $ref: '#/components/schemas/CustomSourceModel'
- $ref: '#/components/schemas/DatabaseSourceModel'
- $ref: '#/components/schemas/DropboxForBusinessSourceModel'
- $ref: '#/components/schemas/FileSourceModel'
- $ref: '#/components/schemas/GenericRestSourceModel'
- $ref: '#/components/schemas/GoogleDriveDomainWideSourceModel'
- $ref: '#/components/schemas/GraphQlSourceModel'
- $ref: '#/components/schemas/Jira2HostedSourceModel'
- $ref: '#/components/schemas/Jira2SourceModel'
- $ref: '#/components/schemas/JiveHostedSourceModel'
- $ref: '#/components/schemas/JiveSourceModel'
- $ref: '#/components/schemas/KhorosSourceModel'
- $ref: '#/components/schemas/MicrosoftDynamicsSourceModel'
- $ref: '#/components/schemas/PushSourceModel'
- $ref: '#/components/schemas/RSSSourceModel'
- $ref: '#/components/schemas/SAPSourceModel'
- $ref: '#/components/schemas/SalesforceSitesSourceModel'
- $ref: '#/components/schemas/SalesforceSourceModel'
- $ref: '#/components/schemas/ServiceNowSourceModel'
- $ref: '#/components/schemas/SharePointOnline2SourceModel'
- $ref: '#/components/schemas/SharePointSourceModel'
- $ref: '#/components/schemas/ShopifySourceModel'
- $ref: '#/components/schemas/SitecoreSourceModel'
- $ref: '#/components/schemas/SitemapSourceModel'
- $ref: '#/components/schemas/SlackSourceModel'
- $ref: '#/components/schemas/Web2SourceModel'
- $ref: '#/components/schemas/YouTubeSourceModel'
- $ref: '#/components/schemas/ZendeskSourceModel'
totalEntries:
type: integer
format: int64
totalPages:
type: integer
format: int32
MetadataReportPageModel:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/SourceMetadataModel'
creationDate:
type: string
format: date-time
expirationDate:
type: string
format: date-time
sampledDocumentCount:
type: integer
format: int32
documentErrorCount:
type: integer
format: int32
totalPages:
type: integer
format: int32
totalEntries:
type: integer
format: int64
MetadataValueModel:
type: object
properties:
metadataValue:
type: object
count:
type: integer
format: int32
SourceMetadataModel:
type: object
properties:
key:
type: string
values:
type: array
items:
$ref: '#/components/schemas/MetadataValueModel'
count:
type: integer
format: int32
origin:
type: string
isMapped:
type: boolean
deprecated: true
indexedBy:
type: string
enum:
- NONE
- FIELD
- MAPPING
SourceMetadataStatusModel:
type: object
properties:
sampleAvailable:
type: boolean
reportGenerationInProgress:
type: boolean
reportAvailable:
type: boolean
Config:
type: object
properties:
documentConsumerURI:
type: string
indexIdentifier:
type: string
dbConnectionString:
type: string
reportingServiceUri:
type: string
sourceInformation:
$ref: '#/components/schemas/SourceInformation'
sourceSecurityOption:
type: string
enum:
- Retrieve
- Specified
- Merge
startingAddresses:
type: array
items:
type: string
addressPatterns:
type: array
items:
$ref: '#/components/schemas/AddressPattern'
permissions:
type: array
items:
$ref: '#/components/schemas/PermissionLevel'
parameters:
type: object
additionalProperties:
$ref: '#/components/schemas/Parameter'
securityProviders:
type: object
additionalProperties:
$ref: '#/components/schemas/SecurityProvider'
userIdentities:
type: object
additionalProperties:
$ref: '#/components/schemas/UserIdentity'
dataFiles:
type: object
additionalProperties:
$ref: '#/components/schemas/DataFile'
caseSensitivePatterns:
type: boolean
documentConfig:
$ref: '#/components/schemas/DocumentConfig'
SourceConfigSnapshotMappingModel:
type: object
properties:
id:
type: string
sourceId:
type: string
type:
type: string
fieldName:
type: string
rules:
type: array
items:
type: string
SourceConfigSnapshotModel:
type: object
properties:
configuration:
$ref: '#/components/schemas/Config'
mappings:
type: array
items:
$ref: '#/components/schemas/SourceConfigSnapshotMappingModel'
PageModelSourceFieldModel:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/SourceFieldModel'
totalPages:
type: integer
format: int32
totalEntries:
type: integer
format: int64
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