Index Configuration Collection (GET, PUT)
Retrieve the saved index configurations. Additionally, you can persist the index configuration.
Resource
Resource Example
Available Version: 62.0
HTTP Methods: GET, PUT
Request Parameters for GET
| Parameter Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
correlationId | String | Unique token to track and associate related events or transactions across different components of the application. If unspecified, a Universally Unique Identifier (UUID) is generated. | Optional | 62.0 |
fieldTypes | String[] | Filters and returns only the persisted index configurations, based on the index configuration type specified in the query parameters. The supported types of filters are STANDARD, CUSTOM, ProductDynamicAttribute, ProductAttributeDefinitionStandard, or ProductAttributeDefinitionCustom. | Optional | 62.0 |
includeMetadata | Boolean | Indicates whether to include metadata (true) or not (false). | Optional | 62.0 |
Response Body for GET: Index Configuration Collection
Request Body for PUT
JSON Example
Properties
| Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
correlationId | String | Unique token to track and associate related events or transactions across different components of the application. If unspecified, a Universally Unique Identifier (UUID) is generated. | Optional | 62.0 |
indexConfigurations | Index Configuration Input[] | List of index configurations. | Required | 62.0 |
Response Body for PUT: Index Configurations Update