openapi: 3.0.1
info:
title: Coveo Activity Activities Sources 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
paths:
/rest/organizations/{organizationId}/schema/sources/SLACK/validateToken:
post:
operationId: validateSlackToken
summary: Validates a Slack OAuth Token
tags:
- Sources
deprecated: false
parameters:
- name: accessTokenGuid
description: The OAuth token Guid linked with the token to validate.
required: false
in: query
type: string
- name: accessToken
description: The OAuth token to validate.
required: false
in: query
type: string
- name: organizationId
description: The organization ID
required: true
in: path
type: string
responses:
'200':
description: OK
schema:
$ref: '#/definitions/SlackTokenValidationStatus'
security:
- oauth2:
- full
/rest/organizations/{organizationId}/schema/sources/{sourceType}/defaultObjectsToGet:
get:
operationId: getDefaultObjectsToGet
summary: Retrieves the Default Objects for a Source of Type Specified.
tags:
- Sources
deprecated: false
parameters:
- name: sourceType
description: The type of the source
required: true
in: path
type: string
- name: organizationId
description: The organization ID
required: true
in: path
type: string
responses:
'200':
description: OK
schema:
$ref: '#/definitions/GenericObjectsToGet'
security:
- oauth2:
- full
/rest/organizations/{organizationId}/schema/sources/{sourceType}/entities:
get:
operationId: getSchemaEntities
summary: Retrieves the List of Entities Present in a Source, in Alphabetical Order of Display Names.
tags:
- Sources
deprecated: false
parameters:
- name: accessTokenGuid
description: The source's access token Guid (if authentified through access token)
required: false
in: query
type: string
- name: entityIds
description: IDs of the entities to retrieve (comma-separated list)
required: false
in: query
type: string
- name: limit
description: The number of entities to retrieve
required: false
in: query
type: integer
format: int32
- name: offset
description: Starting index of the first entity to retrieve
required: false
in: query
type: integer
format: int32
- name: query
description: A query used to match specific entities
required: false
in: query
type: string
- name: username
description: The source's username (if authentified through OAuth).
required: false
in: query
type: string
- name: passwordGuid
description: The source's password Guid (if authentified through Basic Auth)
required: false
in: query
type: string
- name: clientId
description: The source's client id(if authentified through OAuth).
required: false
in: query
type: string
- name: clientSecretGuid
description: The source's client secret Guid (if authentified through OAuth).
required: false
in: query
type: string
- name: oauthRefreshTokenGuid
description: The source's refresh token Guid (if authentified through OAuth).
required: false
in: query
type: string
- name: instanceUrl
description: The source's instance Url.
required: true
in: query
type: string
- name: sourceType
description: The type of the source
required: true
in: path
type: string
- name: organizationId
description: The organization ID
required: true
in: path
type: string
responses:
'200':
description: OK
schema:
$ref: '#/definitions/SchemaEntities'
security:
- oauth2:
- full
/rest/organizations/{organizationId}/schema/sources/{sourceType}/entities/{entityId}:
get:
operationId: getSchemaEntity
summary: Retrieves the Entity Specified with Its Fields.
tags:
- Sources
deprecated: false
parameters:
- name: filter
description: The record count filter
required: false
in: query
type: string
- name: username
description: The source's username (if authentified through OAuth).
required: false
in: query
type: string
- name: passwordGuid
description: The source's password Guid (if authentified through Basic Auth)
required: false
in: query
type: string
- name: clientId
description: The source's client id(if authentified through OAuth).
required: false
in: query
type: string
- name: clientSecretGuid
description: The source's client secret Guid (if authentified through OAuth).
required: false
in: query
type: string
- name: oauthRefreshTokenGuid
description: The source's refresh token Guid (if authentified through OAuth).
required: false
in: query
type: string
- name: instanceUrl
description: The source's instance Url.
required: true
in: query
type: string
- name: entityId
description: The id of the entity
required: true
in: path
type: string
- name: sourceType
description: The type of the source
required: true
in: path
type: string
- name: organizationId
description: The organization ID
required: true
in: path
type: string
responses:
'200':
description: OK
schema:
$ref: '#/definitions/SchemaEntities'
security:
- oauth2:
- full
/rest/organizations/{organizationId}/schema/sources/{sourceType}/entities/{entityId}/fields:
get:
operationId: getSchemaEntityFields
summary: Retrieves the Specified Entity, with Its Fields in Alphabetical Order of Display Names.
tags:
- Sources
deprecated: false
parameters:
- name: username
description: The source's username (if authentified through OAuth).
required: false
in: query
type: string
- name: passwordGuid
description: The source's password Guid (if authentified through Basic Auth)
required: false
in: query
type: string
- name: clientId
description: The source's client id(if authentified through OAuth).
required: false
in: query
type: string
- name: clientSecretGuid
description: The source's client secret Guid (if authentified through OAuth).
required: false
in: query
type: string
- name: oauthRefreshTokenGuid
description: The source's refresh token Guid (if authentified through OAuth).
required: false
in: query
type: string
- name: instanceUrl
description: The source's instance Url.
required: true
in: query
type: string
- name: entityId
description: The name of the entity
required: true
in: path
type: string
- name: sourceType
description: The type of the source
required: true
in: path
type: string
- name: organizationId
description: The organization ID
required: true
in: path
type: string
responses:
'200':
description: OK
schema:
$ref: '#/definitions/SchemaEntities'
security:
- oauth2:
- full
/rest/organizations/{organizationId}/schema/sources/{sourceType}/translate/generic:
post:
operationId: translateToGeneric
summary: Computes the Generic Objects to Get from a Specific Objects to Get.
tags:
- Sources
deprecated: false
parameters:
- name: specificOTG
description: Specific objects to get
required: true
in: body
schema:
type: string
- name: sourceType
description: The type of the source
required: true
in: path
type: string
- name: organizationId
description: The organization ID
required: true
in: path
type: string
responses:
'200':
description: OK
schema:
$ref: '#/definitions/GenericObjectsToGet'
security:
- oauth2:
- full
/rest/organizations/{organizationId}/schema/sources/{sourceType}/translate/specific:
post:
operationId: translateToSpecific
summary: Computes the Specific Objects to Get from a Generic Objects to Get.
tags:
- Sources
deprecated: false
parameters:
- name: genericOTG
description: Generic objects to get
required: true
in: body
schema:
type: string
- name: sourceType
description: The type of the source
required: true
in: path
type: string
- name: organizationId
description: The organization ID
required: true
in: path
type: string
responses:
'200':
description: OK
schema:
$ref: '#/definitions/SpecificObjectsToGet'
security:
- oauth2:
- full
/rest/organizations/{organizationId}/schema/sources/{sourceType}/translate/specificWithMappings:
post:
operationId: translateToSpecificWithMappings
summary: Computes the Specific Objects to Get from a Generic Objects to Get with a List of Mapping Description
tags:
- Sources
deprecated: false
parameters:
- name: accessTokenGuid
description: The source's access token Guid (if authentified through access token)
required: false
in: query
type: string
- name: username
description: The source's username (if authentified through OAuth).
required: false
in: query
type: string
- name: passwordGuid
description: The source's password Guid (if authentified through Basic Auth)
required: false
in: query
type: string
- name: clientId
description: The source's client id(if authentified through OAuth).
required: false
in: query
type: string
- name: clientSecretGuid
description: The source's client secret Guid (if authentified through OAuth).
required: false
in: query
type: string
- name: oauthRefreshTokenGuid
description: The source's refresh token Guid (if authentified through OAuth).
required: false
in: query
type: string
- name: instanceUrl
description: The source's instance Url.
required: true
in: query
type: string
- name: sourceType
description: The type of the source
required: true
in: path
type: string
- name: organizationId
description: The organization ID
required: true
in: path
type: string
responses:
'200':
description: OK
schema:
$ref: '#/definitions/JValue'
security:
- oauth2:
- full
/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}"}
```
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}"}
```
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":"VIEW","targetId":"*"}
```
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":"*"}
```
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.
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
SalesforceInConditionValue:
type: object
properties:
type:
type: string
enum:
- SOQL_STRING
- SOQL_ID
- SOQL_DATETIME
- SOQL_BOOLEAN
- SOQL_OTHER
value:
type: string
FormInput:
type: object
properties:
name:
type: string
value:
type: string
inputType:
type: string
enum:
- Input
- Username
- Password
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
LanguageHint:
type: object
properties:
language:
type: string
probability:
type: number
format: double
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
MetafieldConfiguration:
type: object
properties:
namespace:
type: string
key:
type: string
name:
type: string
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
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'
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
DocumentPermissionModel:
type: object
properties:
lastUpdatedDate:
type: string
description: The date of the last permission model refresh in number of milliseconds since UNIX epoch.**Example:** `1539703378000`
format: date-time
state:
type: string
description: 'The state of the item permission model.**Allowed values:** - `VALID`: Permission model updated. All identities in the permission model are valid and up to date. - `PENDING`: Permission model not updated yet. - `INCOMPLETE`: Permission model updated, but at least one allowed identity is not up to date, or at least one permission level (except level 0) contains at least one denied identity that was not successfully updated. - `IN_ERROR`: Permission model updated. However, permission level 0 contains at least one denied identity that was not successfully updated. - `WARNING`: The permission model has been updated, but at least one denied entity is out of date. The Denied effective permission list may therefore be incomplete. This issue requires immediate attention, as it can cause a security hole. - `UNKNOWN`: The state of the permission model is unknown.
'
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).
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
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
DetailedSecurityIdentityModel:
type: object
properties:
name:
type: string
provider:
type: string
type:
type: string
infos:
type: array
items:
$ref: '#/components/schemas/SecurityIdentityInfoModel'
declaration:
type: string
state:
type: string
enum:
- UNKNOWN
- UP_TO_DATE
- NOT_UPDATED
- OUT_OF_DATE
- IN_ERROR
- DISABLED
createdDate:
type: string
format: date-time
lastEnabledDate:
type: string
format: date-time
lastUpdateDate:
type: string
format: date-time
lastSuccessfulUpdateDate:
type: string
format: date-time
lastStoredDate:
type: string
format: date-time
orderingID:
type: integer
format: int64
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
AuthenticationFailedConfiguration:
type: object
properties:
method:
type: string
enum:
- RedirectedToUrl
- PageDoesNotContain
- PageContains
- CookieNotSet
- UrlMatch
- UrlDoesNotMatch
values:
type: array
items:
type: string
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
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
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
MicrosoftDynamicsFetchXmlQuery:
type: object
properties:
id:
type: string
name:
type: string
queryXml:
type: string
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
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
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
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
FieldMappingModel:
type: object
properties:
sourceId:
type: string
sourceName:
type: string
mappings:
type: array
items:
$ref: '#/components/schemas/MappingModel'
ParameterModel:
type: object
properties:
value:
type: string
sensitive:
type: boolean
PermissionSetModel:
type: object
properties:
anonymousAllowed:
type: boolean
name:
type: string
permissions:
type: array
items:
$ref: '#/components/schemas/SinglePermissionModel'
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
MicrosoftDynamicsConditions:
type: object
properties:
conditions:
type: array
items:
$ref: '#/components/schemas/MicrosoftDynamicsCondition'
PostLoginSequence:
type: object
properties:
url:
type: string
pageContainsValue:
type: string
urlContainsValue:
type: string
name:
type: string
steps:
type: array
items:
$ref: '#/components/schemas/FormAuthStep'
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
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
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
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
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
BoxEnterprise2SourceModel:
type: object
allOf:
- $ref: '#/components/schemas/SourceModel'
- type: object
properties:
boxEnterpriseSettingsData:
type: string
hasBoxEnterpriseSettingsData:
type: boolean
usersToCrawl:
type: string
HourMinutePair:
type: object
properties:
hour:
type: integer
format: int32
minute:
type: integer
format: int32
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'
AmazonS3SourceModel:
type: object
allOf:
- $ref: '#/components/schemas/SourceModel'
- type: object
properties:
urls:
type: array
items:
type: string
accessKey:
type: string
secretKey:
type: string
hasSecretKey:
type: boolean
YouTubeSourceModel:
type: object
allOf:
- $ref: '#/components/schemas/SourceModel'
- type: object
properties:
urls:
type: array
items:
type: string
indexPlaylists:
type: boolean
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'
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
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/).
ExtensionSettingByExtension:
type: object
properties:
extensions:
type: array
items:
type: string
extensionSetting:
$ref: '#/components/schemas/ExtensionSetting'
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
MicrosoftDynamicsRelation:
type: object
properties:
alias:
type: string
attributes:
type: array
items:
type: string
fromAttribute:
type: string
toAttribute:
type: string
toEntity:
type: string
PushSourceModel:
type: object
allOf:
- $ref: '#/components/schemas/SourceModel'
Parameter:
type: object
properties:
sensitive:
type: boolean
value:
type: string
DatabaseSourceModel:
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
configFileContent:
type: string
connectionString:
type: string
driverType:
type: string
forceLastRefreshUTC:
type: boolean
itemType:
type: string
commandTimeout:
type: integer
format: int32
queryPageSize:
type: integer
format: int32
SourceConfigSnapshotModel:
type: object
properties:
configuration:
$ref: '#/components/schemas/Config'
mappings:
type: array
items:
$ref: '#/components/schemas/SourceConfigSnapshotMappingModel'
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'
PermissionModel:
type: object
properties:
permissionLevels:
type: array
items:
$ref: '#/components/schemas/PermissionLevel'
SourceConfigSnapshotMappingModel:
type: object
properties:
id:
type: string
sourceId:
type: string
type:
type: string
fieldName:
type: string
rules:
type: array
items:
type: string
Confluence2HostedSourceModel:
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
indexAttachments:
type: boolean
indexComments:
type: boolean
indexOnlyGlobalSpaces:
type: boolean
indexOnlyPersonalSpaces:
type: boolean
indexArchivedSpaces:
type: boolean
indexCurrentSpaces:
type: boolean
useRequestParametersAuth:
type: boolean
alwaysSendBasicAuthenticationHeaders:
type: boolean
useKerberosAuthentication:
type: boolean
rootSpaceRegex:
type: string
filterSpaceRegex:
type: string
usePersonalAccessToken:
type: boolean
apiKey:
type: string
useApiKey:
type: boolean
Confluence2SourceModel:
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
indexAttachments:
type: boolean
indexComments:
type: boolean
indexOnlyGlobalSpaces:
type: boolean
indexOnlyPersonalSpaces:
type: boolean
indexArchivedSpaces:
type: boolean
indexCurrentSpaces:
type: boolean
useRequestParametersAuth:
type: boolean
alwaysSendBasicAuthenticationHeaders:
type: boolean
useKerberosAuthentication:
type: boolean
rootSpaceRegex:
type: string
filterSpaceRegex:
type: string
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
MicrosoftDynamicsFetchXmlQueries:
type: object
properties:
queries:
type: array
items:
$ref: '#/components/schemas/MicrosoftDynamicsFetchXmlQuery'
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
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
ConditionNode:
type: object
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/).
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
ExtendedDataFile:
type: object
properties:
sensitive:
type: boolean
data:
type: string
extendedData:
type: object
PageModelSourceFieldModel:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/SourceFieldModel'
totalPages:
type: integer
format: int32
totalEntries:
type: integer
format: int64
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
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
CharsetDetectionHint:
type: object
properties:
charset:
type: string
confidence:
type: number
format: double
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
MemoryLimits:
type: object
properties:
conversionLimit:
type: integer
format: int32
extensionLimit:
type: integer
format: int32
mappingLimit:
type: integer
format: int32
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
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
SitecoreSourceModel:
type: object
allOf:
- $ref: '#/components/schemas/SourceModel'
FormElementIdentifier:
type: object
properties:
identifier:
type: string
type:
type: string
findType:
type: string
SecurityIdentityInfoModel:
type: object
properties:
key:
type: string
value:
type: string
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
Permission:
type: object
properties:
identityType:
type: string
enum:
- Unknown
- User
- Group
- VirtualGroup
securityProvider:
type: string
identity:
type: string
additionalInfo:
type: object
additionalProperties:
type: string
SecurityProviderReferenceModel:
type: object
properties:
type:
type: string
enum:
- SOURCE
- SECURITY_PROVIDER
id:
type: string
attributes:
type: object
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
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'
UserIdentity:
type: object
properties:
name:
type: string
userName:
type: string
password:
type: string
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'
DataFile:
type: object
properties:
sensitive:
type: boolean
data:
type: string
SourcePermissionsUpdateModel:
type: object
properties:
permissionBehavior:
type: string
enum:
- UseCrawler
- Override
- Merge
permissions:
$ref: '#/components/schemas/PermissionModel'
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
SecurityProvider:
type: object
properties:
name:
type: string
typeName:
type: string
CatalogSourceModel:
type: object
allOf:
- $ref: '#/components/schemas/SourceModel'
ConfigurationError:
type: object
properties:
errorCode:
type: string
message:
type: string
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
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
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
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
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
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
DocumentProcessor:
type: object
properties:
type:
type: string
parameters:
$ref: '#/components/schemas/DocumentProcessorParameters'
UrlFilter:
type: object
properties:
filter:
type: string
includeFilter:
type: boolean
filterType:
type: string
enum:
- WILDCARD
- REGEX
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
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
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'
PermissionLevel:
type: object
properties:
permissionSets:
type: array
items:
$ref: '#/components/schemas/PermissionSet'
name:
type: string
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
AddressPattern:
type: object
properties:
expression:
type: string
patternType:
type: string
enum:
- Wildcard
- RegEx
allowed:
type: boolean
CustomSourceModel:
type: object
allOf:
- $ref: '#/components/schemas/SourceModel'
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
FormAction:
type: object
properties:
type:
type: string
value:
type: string
elementIdentifier:
$ref: '#/components/schemas/FormElementIdentifier'
waitDelayInMilliseconds:
type: integer
format: int32
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'
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
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'
CustomLoginSequence:
type: object
properties:
url:
type: string
pageContainsValue:
type: string
urlContainsValue:
type: string
name:
type: string
steps:
type: array
items:
$ref: '#/components/schemas/FormAuthStep'
securitySchemes:
oauth2:
type: oauth2
flows:
authorizationCode:
authorizationUrl: https://platform.cloud.coveo.com/oauth/authorize
tokenUrl: https://platform.cloud.coveo.com/oauth/token
scopes:
full: required
definitions:
SalesforceChildRelationships:
type: object
properties:
name:
description: The child relationship name
type: string
fields:
description: The child object fields to be indexed
type: array
items:
type: string
parentRelationships:
description: The fields from a parent objects that have a parent relationship with this object.
type: array
items:
$ref: '#/definitions/SalesforceParentRelationships'
required:
- name
- fields
JValue:
type: object
properties: {}
SlackTokenValidationStatus:
type: object
properties:
valid:
description: Whether or not the token id valid.
type: boolean
workspace:
description: Workspace linked to the token.
type: string
reason:
description: Invalid token reason code.
type: string
details:
description: Provides more details on status.
type: string
required:
- valid
SchemaEntity:
type: object
properties:
displayName:
description: The display name of the entity
type: string
id:
description: The entity ID
type: string
recordCount:
description: The record count of the entity
type: integer
format: int32
fields:
description: The entity fields
type: array
items:
$ref: '#/definitions/SchemaField'
settings:
description: The entity settings
type: object
additionalProperties:
type: string
required:
- displayName
- id
GenericObject:
type: object
properties:
ObjectName:
description: The object name
type: string
Fields:
description: The object fields to be indexed
type: array
items:
type: string
ParentRelationships:
description: The fields from a parent objects that have a parent relationship with this object.
type: array
items:
$ref: '#/definitions/SalesforceParentRelationships'
childRelationships:
description: The fields from a child objects that have a child relationship with this object.
type: array
items:
$ref: '#/definitions/SalesforceChildRelationships'
polymorphicRelationships:
description: The fields from an objects that have a Polymorphic relationship with this object.
type: array
items:
$ref: '#/definitions/SalesforcePolymorphicRelationships'
required:
- ObjectName
- Fields
SchemaEntities:
type: object
properties:
entitiesCount:
description: The total number of entities
type: integer
format: int32
entities:
description: The collection of entities
type: array
items:
$ref: '#/definitions/SchemaEntity'
required:
- entities
GenericObjectsToGet:
type: object
properties:
objects:
description: The collection of objects to get
type: array
items:
$ref: '#/definitions/GenericObject'
SalesforcePolymorphicRelationships:
type: object
properties:
name:
description: The child relationship name
type: string
objectName:
description: The object name to match
type: string
fields:
description: The object fields to be indexed
type: array
items:
type: string
required:
- name
- objectName
- fields
SpecificObjectsToGet:
type: object
properties: {}
SchemaField:
type: object
properties:
displayName:
description: The display name of the entity field
type: string
id:
description: The entity field ID
type: string
type:
description: The field type of the entity in Coveo Cloud
type: string
reference:
description: The name of the entity that is optionally referenced by the field
type: string
isAlwaysIndexed:
description: A flag marking whether this field is indexed by the connector automatically
type: boolean
required:
- displayName
- id
- type
SalesforceParentRelationships:
type: object
properties:
relationshipName:
description: The parent relationship name
type: string
fields:
description: The parent object fields to be indexed
type: array
items:
type: string
required:
- relationshipName
- fields