Index Configuration Collection
Output representation of the collection of index configuration details.
- JSON example
-
{ "correlationId": "ad960cb6-392d-4d11-bac3-3824baedf67e", "errors": [], "indexConfigurations": [ { "isSearchable": true, "name": "Name", "type": "Standard" } ], "metadata": { "objectInfos": [ { "fields": [ { "dataType": "text", "isFacetableConfigurable": true, "isSearchableConfigurable": false, "label": "Product Name", "name": "Name", "type": "Standard" }, { "dataType": "multilinetext", "isFacetableConfigurable": false, "isSearchableConfigurable": true, "label": "Product Description", "name": "Description", "type": "Standard" } ], "name": "Product2" }, { "fields": [ { "dataType": "stringplusclob", "label": "Description", "name": "Description", "type": "ProductAttributeDefinitionStandard" }, { "dataType": "text", "label": "Name", "name": "Name", "type": "ProductAttributeDefinitionStandard" }, ], "name": "ProductAttributeDefinition" } ] }, "statusCode": "200" }
Property Name | Type | Description | Filter Group and Version | 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. | Small, 62.0 | 62.0 |
errors | Error Output[] | List of errors, if any. | Small, 62.0 | 62.0 |
indexConfigurations | Index Configuration Field[] | Details of the index-configured fields. | Small, 62.0 | 62.0 |
metadata | Metadata[] | Details of the metadata for objects. | Small, 62.0 | 62.0 |
statusCode | String | Code that indicates the status of the request. | Small, 62.0 | 62.0 |