Snapshot Deployment

Output representation of the snapshot deployment.

JSON Example

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

1{
2  "errors": [],
3  "snapshot": {
4    "activationStatus": "NONE",
5    "activationType": "IMMEDIATE",
6    "id": "1Avxx0000004CFU",
7    "snapshotIndexes": [
8      {
9        "createdDate": "2024-07-24T21:10:48.000Z",
10        "id": "1D6xx0000004CFU",
11        "indexBuildType": "FULL",
12        "indexType": "PRODUCT",
13        "lastBuildStatus": "IN_PROGRESS"
14      }
15    ]
16  },
17  "statusCode": "200"
18}

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

1{
2  "errors": [],
3  "snapshot": {
4    "activationStatus": "NONE",
5    "activationType": "IMMEDIATE",
6    "id": "1Avxx0000004CH6",
7    "snapshotIndexes": [
8      {
9        "createdDate": "2024-07-24T21:13:05.000Z",
10        "id": "1D6xx0000004CH6",
11        "indexBuildType": "FULL",
12        "indexType": "PRODUCT",
13        "lastBuildStatus": "IN_PROGRESS"
14      }
15    ]
16  },
17  "statusCode": "200"
18}

Properties

Property Name	Type	Description	Filter Group and Version	Available Version
`errors`	Error Output[]	List of errors, if any.	Small, 62.0	62.0
`snapshot`	Snapshot[]	Run-time catalog snapshot associated with the created index.	Small, 62.0	62.0
`statusCode`	String	Code indicating the status of the request.	Small, 62.0	62.0