Creates a new field in the index of the target Coveo Cloud organization.
Required privilege: Fields - Create
{"owner":"PLATFORM","targetDomain":"FIELD","type":"CREATE","targetId":"*"}
organizationId required | string The unique identifier of the target organization. |
automaticFacetsCandidate | boolean Whether this field is to be considered by the facet generator feature. |
dateFormat | string A regex indicating the date format, for some |
description | string A description of the field. |
facet | |
hierarchicalFacet | boolean Whether the field contains multiple values that form a hierarchy (see also the |
includeInQuery | boolean Whether this field can be referred to in Coveo Cloud query syntax expressions. |
includeInResults | boolean Whether the field can be included in the raw property of query results. |
keepAccentsDisplayValueFacet | boolean Whether field values with differing accents should be considered distinct facet values. |
keyValue | boolean Whether the field is a dictionary field, which contains mappings of keys to values instead of a single value. |
label | string A displayable label for the field when used by the facet generator. |
mergeWithLexicon | boolean Whether the field is free text searchable. |
multiValueFacet | boolean Whether the field contains multiple values (see also the |
multiValueFacetTokenizers | string The character to use as a value separator, if the field contains multiple values (see also the |
name | string The name of the field, also referred to as the field identifier, or |
ranking | boolean Whether to use the field in result ranking calculation only. |
smartDateFacet | boolean Whether to transform date and time string values into semicolon separated number of days/weeks/months/quarters/years since January 1st, 1900. |
sort | boolean Whether query results can be sorted based on the value of the field. |
stemming | boolean Whether to allow an item to match the query when the value of this field for this item stems from the same root as one of the query expression keywords. |
system | boolean Whether the field is a standard Coveo field. |
type | string Enum: "LONG" "LONG_64" "DOUBLE" "DATE" "STRING" … 1 more The data type of the field. |
useCacheForComputedFacet | boolean Whether to keep computed field data in memory. |
useCacheForNestedQuery | boolean Whether to keep the data required to perform nested queries in memory. |
useCacheForNumericQuery | boolean Whether to keep the data required to execute operations on numeric and date fields in memory. |
useCacheForSort | boolean Whether to keep the entire field in memory for fast sorting. |
{- "automaticFacetsCandidate": true,
- "dateFormat": "string",
- "description": "string",
- "facet": true,
- "hierarchicalFacet": true,
- "includeInQuery": true,
- "includeInResults": true,
- "keepAccentsDisplayValueFacet": true,
- "keyValue": true,
- "label": "string",
- "mergeWithLexicon": true,
- "multiValueFacet": true,
- "multiValueFacetTokenizers": "string",
- "name": "string",
- "ranking": true,
- "smartDateFacet": true,
- "sort": true,
- "stemming": true,
- "system": true,
- "type": "LONG",
- "useCacheForComputedFacet": true,
- "useCacheForNestedQuery": true,
- "useCacheForNumericQuery": true,
- "useCacheForSort": true
}
Creates a batch of fields in the index of the target Coveo Cloud organization.
Required privilege: Fields - Create
{"owner":"PLATFORM","targetDomain":"FIELD","type":"CREATE","targetId":"*"}
organizationId required | string The unique identifier of the target organization. |
automaticFacetsCandidate | boolean Whether this field is to be considered by the facet generator feature. |
dateFormat | string A regex indicating the date format, for some |
description | string A description of the field. |
facet | |
hierarchicalFacet | boolean Whether the field contains multiple values that form a hierarchy (see also the |
includeInQuery | boolean Whether this field can be referred to in Coveo Cloud query syntax expressions. |
includeInResults | boolean Whether the field can be included in the raw property of query results. |
keepAccentsDisplayValueFacet | boolean Whether field values with differing accents should be considered distinct facet values. |
keyValue | boolean Whether the field is a dictionary field, which contains mappings of keys to values instead of a single value. |
label | string A displayable label for the field when used by the facet generator. |
mergeWithLexicon | boolean Whether the field is free text searchable. |
multiValueFacet | boolean Whether the field contains multiple values (see also the |
multiValueFacetTokenizers | string The character to use as a value separator, if the field contains multiple values (see also the |
name | string The name of the field, also referred to as the field identifier, or |
ranking | boolean Whether to use the field in result ranking calculation only. |
smartDateFacet | boolean Whether to transform date and time string values into semicolon separated number of days/weeks/months/quarters/years since January 1st, 1900. |
sort | boolean Whether query results can be sorted based on the value of the field. |
stemming | boolean Whether to allow an item to match the query when the value of this field for this item stems from the same root as one of the query expression keywords. |
system | boolean Whether the field is a standard Coveo field. |
type | string Enum: "LONG" "LONG_64" "DOUBLE" "DATE" "STRING" … 1 more The data type of the field. |
useCacheForComputedFacet | boolean Whether to keep computed field data in memory. |
useCacheForNestedQuery | boolean Whether to keep the data required to perform nested queries in memory. |
useCacheForNumericQuery | boolean Whether to keep the data required to execute operations on numeric and date fields in memory. |
useCacheForSort | boolean Whether to keep the entire field in memory for fast sorting. |
[- {
- "automaticFacetsCandidate": true,
- "dateFormat": "string",
- "description": "string",
- "facet": true,
- "hierarchicalFacet": true,
- "includeInQuery": true,
- "includeInResults": true,
- "keepAccentsDisplayValueFacet": true,
- "keyValue": true,
- "label": "string",
- "mergeWithLexicon": true,
- "multiValueFacet": true,
- "multiValueFacetTokenizers": "string",
- "name": "string",
- "ranking": true,
- "smartDateFacet": true,
- "sort": true,
- "stemming": true,
- "system": true,
- "type": "LONG",
- "useCacheForComputedFacet": true,
- "useCacheForNestedQuery": true,
- "useCacheForNumericQuery": true,
- "useCacheForSort": true
}
]
Creates a batch of fields in the index of the target Coveo Cloud organization.
Required privilege: Fields - Create
{"owner":"PLATFORM","targetDomain":"FIELD","type":"CREATE","targetId":"*"}
organizationId required | string The unique identifier of the target organization. |
automaticFacetsCandidate | boolean Whether this field is to be considered by the facet generator feature. |
dateFormat | string A regex indicating the date format, for some |
description | string A description of the field. |
facet | |
hierarchicalFacet | boolean Whether the field contains multiple values that form a hierarchy (see also the |
includeInQuery | boolean Whether this field can be referred to in Coveo Cloud query syntax expressions. |
includeInResults | boolean Whether the field can be included in the raw property of query results. |
keepAccentsDisplayValueFacet | boolean Whether field values with differing accents should be considered distinct facet values. |
keyValue | boolean Whether the field is a dictionary field, which contains mappings of keys to values instead of a single value. |
label | string A displayable label for the field when used by the facet generator. |
mergeWithLexicon | boolean Whether the field is free text searchable. |
multiValueFacet | boolean Whether the field contains multiple values (see also the |
multiValueFacetTokenizers | string The character to use as a value separator, if the field contains multiple values (see also the |
name | string The name of the field, also referred to as the field identifier, or |
ranking | boolean Whether to use the field in result ranking calculation only. |
smartDateFacet | boolean Whether to transform date and time string values into semicolon separated number of days/weeks/months/quarters/years since January 1st, 1900. |
sort | boolean Whether query results can be sorted based on the value of the field. |
stemming | boolean Whether to allow an item to match the query when the value of this field for this item stems from the same root as one of the query expression keywords. |
system | boolean Whether the field is a standard Coveo field. |
type | string Enum: "LONG" "LONG_64" "DOUBLE" "DATE" "STRING" … 1 more The data type of the field. |
useCacheForComputedFacet | boolean Whether to keep computed field data in memory. |
useCacheForNestedQuery | boolean Whether to keep the data required to perform nested queries in memory. |
useCacheForNumericQuery | boolean Whether to keep the data required to execute operations on numeric and date fields in memory. |
useCacheForSort | boolean Whether to keep the entire field in memory for fast sorting. |
[- {
- "automaticFacetsCandidate": true,
- "dateFormat": "string",
- "description": "string",
- "facet": true,
- "hierarchicalFacet": true,
- "includeInQuery": true,
- "includeInResults": true,
- "keepAccentsDisplayValueFacet": true,
- "keyValue": true,
- "label": "string",
- "mergeWithLexicon": true,
- "multiValueFacet": true,
- "multiValueFacetTokenizers": "string",
- "name": "string",
- "ranking": true,
- "smartDateFacet": true,
- "sort": true,
- "stemming": true,
- "system": true,
- "type": "LONG",
- "useCacheForComputedFacet": true,
- "useCacheForNestedQuery": true,
- "useCacheForNumericQuery": true,
- "useCacheForSort": true
}
]
Deletes a batch of fields in the index of the target Coveo Cloud organization.
Required privilege: Fields - Edit
{"owner":"PLATFORM","targetDomain":"FIELD","type":"EDIT","targetId":"*"}
organizationId required | string The unique identifier of the target organization. |
fields required | Array of strings The |
Deletes a batch of fields in the index of the target Coveo Cloud organization.
Required privilege: Fields - Edit
{"owner":"PLATFORM","targetDomain":"FIELD","type":"EDIT","targetId":"*"}
organizationId required | string The unique identifier of the target organization. |
fields required | Array of strings The |
Updates a batch of existing fields in the index of the target Coveo Cloud organization.
Required privilege: Fields - Edit
{"owner":"PLATFORM","targetDomain":"FIELD","type":"EDIT","targetId":"*"}
organizationId required | string The unique identifier of the target organization. |
automaticFacetsCandidate | boolean Whether this field is to be considered by the facet generator feature. |
dateFormat | string A regex indicating the date format, for some |
description | string A description of the field. |
facet | |
hierarchicalFacet | boolean Whether the field contains multiple values that form a hierarchy (see also the |
includeInQuery | boolean Whether this field can be referred to in Coveo Cloud query syntax expressions. |
includeInResults | boolean Whether the field can be included in the raw property of query results. |
keepAccentsDisplayValueFacet | boolean Whether field values with differing accents should be considered distinct facet values. |
keyValue | boolean Whether the field is a dictionary field, which contains mappings of keys to values instead of a single value. |
label | string A displayable label for the field when used by the facet generator. |
mergeWithLexicon | boolean Whether the field is free text searchable. |
multiValueFacet | boolean Whether the field contains multiple values (see also the |
multiValueFacetTokenizers | string The character to use as a value separator, if the field contains multiple values (see also the |
name | string The name of the field, also referred to as the field identifier, or |
ranking | boolean Whether to use the field in result ranking calculation only. |
smartDateFacet | boolean Whether to transform date and time string values into semicolon separated number of days/weeks/months/quarters/years since January 1st, 1900. |
sort | boolean Whether query results can be sorted based on the value of the field. |
stemming | boolean Whether to allow an item to match the query when the value of this field for this item stems from the same root as one of the query expression keywords. |
system | boolean Whether the field is a standard Coveo field. |
type | string Enum: "LONG" "LONG_64" "DOUBLE" "DATE" "STRING" … 1 more The data type of the field. |
useCacheForComputedFacet | boolean Whether to keep computed field data in memory. |
useCacheForNestedQuery | boolean Whether to keep the data required to perform nested queries in memory. |
useCacheForNumericQuery | boolean Whether to keep the data required to execute operations on numeric and date fields in memory. |
useCacheForSort | boolean Whether to keep the entire field in memory for fast sorting. |
[- {
- "automaticFacetsCandidate": true,
- "dateFormat": "string",
- "description": "string",
- "facet": true,
- "hierarchicalFacet": true,
- "includeInQuery": true,
- "includeInResults": true,
- "keepAccentsDisplayValueFacet": true,
- "keyValue": true,
- "label": "string",
- "mergeWithLexicon": true,
- "multiValueFacet": true,
- "multiValueFacetTokenizers": "string",
- "name": "string",
- "ranking": true,
- "smartDateFacet": true,
- "sort": true,
- "stemming": true,
- "system": true,
- "type": "LONG",
- "useCacheForComputedFacet": true,
- "useCacheForNestedQuery": true,
- "useCacheForNumericQuery": true,
- "useCacheForSort": true
}
]
Updates a batch of existing fields in the index of the target Coveo Cloud organization.
Required privilege: Fields - Edit
{"owner":"PLATFORM","targetDomain":"FIELD","type":"EDIT","targetId":"*"}
organizationId required | string The unique identifier of the target organization. |
automaticFacetsCandidate | boolean Whether this field is to be considered by the facet generator feature. |
dateFormat | string A regex indicating the date format, for some |
description | string A description of the field. |
facet | |
hierarchicalFacet | boolean Whether the field contains multiple values that form a hierarchy (see also the |
includeInQuery | boolean Whether this field can be referred to in Coveo Cloud query syntax expressions. |
includeInResults | boolean Whether the field can be included in the raw property of query results. |
keepAccentsDisplayValueFacet | boolean Whether field values with differing accents should be considered distinct facet values. |
keyValue | boolean Whether the field is a dictionary field, which contains mappings of keys to values instead of a single value. |
label | string A displayable label for the field when used by the facet generator. |
mergeWithLexicon | boolean Whether the field is free text searchable. |
multiValueFacet | boolean Whether the field contains multiple values (see also the |
multiValueFacetTokenizers | string The character to use as a value separator, if the field contains multiple values (see also the |
name | string The name of the field, also referred to as the field identifier, or |
ranking | boolean Whether to use the field in result ranking calculation only. |
smartDateFacet | boolean Whether to transform date and time string values into semicolon separated number of days/weeks/months/quarters/years since January 1st, 1900. |
sort | boolean Whether query results can be sorted based on the value of the field. |
stemming | boolean Whether to allow an item to match the query when the value of this field for this item stems from the same root as one of the query expression keywords. |
system | boolean Whether the field is a standard Coveo field. |
type | string Enum: "LONG" "LONG_64" "DOUBLE" "DATE" "STRING" … 1 more The data type of the field. |
useCacheForComputedFacet | boolean Whether to keep computed field data in memory. |
useCacheForNestedQuery | boolean Whether to keep the data required to perform nested queries in memory. |
useCacheForNumericQuery | boolean Whether to keep the data required to execute operations on numeric and date fields in memory. |
useCacheForSort | boolean Whether to keep the entire field in memory for fast sorting. |
[- {
- "automaticFacetsCandidate": true,
- "dateFormat": "string",
- "description": "string",
- "facet": true,
- "hierarchicalFacet": true,
- "includeInQuery": true,
- "includeInResults": true,
- "keepAccentsDisplayValueFacet": true,
- "keyValue": true,
- "label": "string",
- "mergeWithLexicon": true,
- "multiValueFacet": true,
- "multiValueFacetTokenizers": "string",
- "name": "string",
- "ranking": true,
- "smartDateFacet": true,
- "sort": true,
- "stemming": true,
- "system": true,
- "type": "LONG",
- "useCacheForComputedFacet": true,
- "useCacheForNestedQuery": true,
- "useCacheForNumericQuery": true,
- "useCacheForSort": true
}
]
Retrieves a filtered and paginated list of fields from the index of the target Coveo Cloud organization.
Required privilege: Fields - View
{"owner":"PLATFORM","targetDomain":"FIELD","type":"VIEW","targetId":"*"}
organizationId required | string |
object (FieldListingFilters) Filters to narrow down the returned fields. | |
order | string The sort direction of the results. |
page | integer <int32> The 0-based number of the page of results to list. |
perPage | integer <int32> The maximum number of results to include per page. |
sortBy | string The field property by which to sort results. |
{- "filters": {
- "automaticFacetsCandidate": "ALL",
- "facet": "ALL",
- "name": "string",
- "origin": "ALL",
- "sort": "ALL",
- "type": "LONG"
}, - "order": "string",
- "page": 0,
- "perPage": 0,
- "sortBy": "string"
}
Deletes a field in the index of the target Coveo Cloud organization.
Required privilege: Fields - Edit
{"owner":"PLATFORM","targetDomain":"FIELD","type":"EDIT","targetId":"*"}
fieldId required | string The |
organizationId required | string The unique identifier of the target organization. |
Shows information regarding a single field in the index of the target Coveo Cloud organization.
Required privilege: Fields - View
{"owner":"PLATFORM","targetDomain":"FIELD","type":"VIEW","targetId":"*"}
fieldId required | string The |
organizationId required | string The unique identifier of the target organization. |
Updates an existing field in the index of the target Coveo Cloud organization.
Required privilege: Fields - Edit
{"owner":"PLATFORM","targetDomain":"FIELD","type":"EDIT","targetId":"*"}
fieldId required | string The |
organizationId required | string The unique identifier of the target organization. |
automaticFacetsCandidate | boolean Whether this field is to be considered by the facet generator feature. |
dateFormat | string A regex indicating the date format, for some |
description | string A description of the field. |
facet | |
hierarchicalFacet | boolean Whether the field contains multiple values that form a hierarchy (see also the |
includeInQuery | boolean Whether this field can be referred to in Coveo Cloud query syntax expressions. |
includeInResults | boolean Whether the field can be included in the raw property of query results. |
keepAccentsDisplayValueFacet | boolean Whether field values with differing accents should be considered distinct facet values. |
keyValue | boolean Whether the field is a dictionary field, which contains mappings of keys to values instead of a single value. |
label | string A displayable label for the field when used by the facet generator. |
mergeWithLexicon | boolean Whether the field is free text searchable. |
multiValueFacet | boolean Whether the field contains multiple values (see also the |
multiValueFacetTokenizers | string The character to use as a value separator, if the field contains multiple values (see also the |
name | string The name of the field, also referred to as the field identifier, or |
ranking | boolean Whether to use the field in result ranking calculation only. |
smartDateFacet | boolean Whether to transform date and time string values into semicolon separated number of days/weeks/months/quarters/years since January 1st, 1900. |
sort | boolean Whether query results can be sorted based on the value of the field. |
stemming | boolean Whether to allow an item to match the query when the value of this field for this item stems from the same root as one of the query expression keywords. |
system | boolean Whether the field is a standard Coveo field. |
type | string Enum: "LONG" "LONG_64" "DOUBLE" "DATE" "STRING" … 1 more The data type of the field. |
useCacheForComputedFacet | boolean Whether to keep computed field data in memory. |
useCacheForNestedQuery | boolean Whether to keep the data required to perform nested queries in memory. |
useCacheForNumericQuery | boolean Whether to keep the data required to execute operations on numeric and date fields in memory. |
useCacheForSort | boolean Whether to keep the entire field in memory for fast sorting. |
{- "automaticFacetsCandidate": true,
- "dateFormat": "string",
- "description": "string",
- "facet": true,
- "hierarchicalFacet": true,
- "includeInQuery": true,
- "includeInResults": true,
- "keepAccentsDisplayValueFacet": true,
- "keyValue": true,
- "label": "string",
- "mergeWithLexicon": true,
- "multiValueFacet": true,
- "multiValueFacetTokenizers": "string",
- "name": "string",
- "ranking": true,
- "smartDateFacet": true,
- "sort": true,
- "stemming": true,
- "system": true,
- "type": "LONG",
- "useCacheForComputedFacet": true,
- "useCacheForNestedQuery": true,
- "useCacheForNumericQuery": true,
- "useCacheForSort": true
}