Snapshot Deployment (POST)

Create indexes for a snapshot. Indexes improve search results and make it easier to find products at run time through search terms.

Resource

1/connect/pcm/index/deploy

Resource Example

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

Available Version: 62.0

HTTP Methods: POST

Request Body for POST

JSON Example

This example shows a sample request to build a new snapshot with immediate activation.

1{
2  "snapshot": {
3    "activationType": "IMMEDIATE"
4  },
5  "buildType": "FULL"
6}

This example shows a sample request to rebuild a snapshot in the active status.

1{
2  "snapshot": {
3    "activationType": "IMMEDIATE",
4    "id": "1Avxx0000005DFe1AM"
5  },
6  "buildType": "FULL"
7}

Properties

NameTypeDescriptionRequired or OptionalAvailable Version
buildTypeStringBuild type of the snapshot index. Valid value is FULL—Specifies a full index build or INCREMENTAL—Specifies an incremental index build. Available from API version 63.0 and later.Required62.0
snapshotRun-time Catalog Snapshot Input[]Snapshot to deploy.Required62.0

Response Body for POST: Snapshot Deployment