Index Configuration Input

Input representation of the request to persist the index configuration.

JSON Example

1"indexConfigurations": [
2    {
3      "attributeDefinitionId": "0tjT1000000002bIAA",
4      "name": "Color",
5      "type": "ProductDynamicAttribute",
6      "isSearchable": true
7    },
8    {
9      "attributeFieldId": "00Nxx000001FwnABII",
10      "name": "Message__c",
11      "type": "Custom",
12      "isSearchable": true
13    },
14    {
15      "name": "Code",
16      "type": "Standard",
17      "isSearchable": true
18    },
19    {
20      "facetDisplayRank": 1,
21      "isFacetable": false,
22      "isSearchable": true,
23      "name": "Family",
24      "type": "Standard"
25    }
26  ]

Properties

Name	Type	Description	Required or Optional	Available Version
`attributeDefinitionId`	String	ID of the attribute definition.	Required if the `attributeFieldId` property isn’t specified.	62.0
`attributeFieldId`	String	ID of the attribute field.	Required if the `attributeDefinitionId` property isn’t specified.	62.0
`facetDisplayRank`	Integer	Sort order for displaying the facets at run time.	Optional	63.0
`isFacetable`	Boolean	Indicates whether the field is facetable (`true`) or not (`false`).	Optional	63.0
`isSearchable`	Boolean	Indicates whether the index-configured field is searchable (`true`) or not (`false`).	Optional	62.0
`name`	String	Name of the index-configured field.	Required	62.0
`type`	String	Type of the index-configured field.	Required	62.0