Property description
The searchIndexes property creates a new index. Once created, define what data it stores by assigning object types to it using the templates > search properties.
Minimal JSON
{
"key": "",
"indexName": ""
}{
"key": "recipe_tutorial_index",
"indexName": "recipe_tutorial_index"
}Example taken from Search Area Configuration.
Nested properties
| Property | Description | Values | Mandatory |
|---|---|---|---|
key | Unique key of the asset. Used for referencing in the same package or other packages using packageKey#assetKey. | string | Yes |
indexName | Name of the index collection that will be created in the elastic search. | string | Yes |
searchIndexSettingsKey | Search index settings that define the structure of the index. We recommend using the default settings instead of defining new. | string | No |
state | Current status of the asset. Supported options are: active (asset is active and visible in the environment), inactive (asset is inactive and hidden, serves as a soft delete), hidden (asset is active but hidden in the environment). | string | No |