Index Configuration Collection (GET, PUT)

Retrieve the saved index configurations. Additionally, you can persist the index configuration.

Resource

1/connect/pcm/index/configurations

Resource Example

1https://{yourInstance}.salesforce.com/services/data/v68.0/connect/pcm/index/configurations

1https://{yourInstance}.salesforce.com/services/data/v68.0/connect/pcm/index/configurations?includeMetadata=false&fieldTypes=Standard,Custom

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

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

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