| Field | Type | Required | Description |
|---|---|---|---|
name |
Optional<String> | ➖ | The name of the property in the DocumentMetadata (e.g. 'createTime', 'updateTime', 'author', 'container'). In the future, this will support custom properties too. |
displayLabel |
Optional<String> | ➖ | The user friendly label for the property. |
displayLabelPlural |
Optional<String> | ➖ | The user friendly label for the property that will be used if a plural context. |
propertyType |
Optional<PropertyType> | ➖ | The type of custom property - this governs the search and faceting behavior. Note that MULTIPICKLIST is not yet supported. |
uiOptions |
Optional<UiOptions> | ➖ | N/A |
hideUiFacet |
Optional<Boolean> | ➖ | If true then the property will not show up as a facet in the UI. |
uiFacetOrder |
Optional<Long> | ➖ | Will be used to set the order of facets in the UI, if present. If set for one facet, must be set for all non-hidden UI facets. Must take on an integer value from 1 (shown at the top) to N (shown last), where N is the number of non-hidden UI facets. These facets will be ordered below the built-in "Type" and "Tag" operators. |
skipIndexing |
Optional<Boolean> | ➖ | If true then the property will not be indexed for retrieval and ranking. |
group |
Optional<String> | ➖ | The unique identifier of the PropertyGroup to which this property belongs. |