Snapshot

Output representation of the list of active snapshots.

JSON Example

1"snapshots": [
2    {
3      "activationDate": "2024-11-06T06:58:02.000Z",
4      "activationStatus": "ACTIVE",
5      "activationType": "IMMEDIATE",
6      "id": "1Avxx0000004C92CAE",
7      "snapshotIndexes": [
8        {
9          "createdDate": "2024-11-06T06:56:49.000Z",
10          "id": "1D6xx0000004C92CAE",
11          "indexBuildType": "FULL",
12          "indexInfos": [
13            {
14              "buildType": "FULL",
15              "id": "0axxx00000000T3AAI",
16              "isIncrementable": true,
17              "usageType": "LIVE"
18            }
19          ],
20          "indexLogs": [
21            {
22              "catalogSnapshotTime": "2024-11-06T16:14:30.000Z",
23              "completionTime": "2024-11-06T16:16:02.000Z",
24              "createdById": "005xx000001X7x7AAC",
25              "indexBuildStatus": "COMPLETED",
26              "indexBuildType": "FULL",
27              "indexId": "0axxx00000000T3AAI",
28              "numberOfChanges": 7
29            },
30            {
31              "catalogSnapshotTime": "2024-11-06T15:03:32.000Z",
32              "completionTime": "2024-11-06T15:05:02.000Z",
33              "createdById": "005xx000001X7x7AAC",
34              "indexBuildStatus": "COMPLETED_WITH_ERRORS",
35              "indexBuildType": "INCREMENTAL",
36              "indexId": "0axxx00000000RRAAY",
37              "message": "Warning: Product errors found.",
38              "numberOfChanges": 3
39            },
40            {
41              "catalogSnapshotTime": "2024-11-06T12:35:34.000Z",
42              "completionTime": "2024-11-06T12:35:34.000Z",
43              "createdById": "005xx000001X7x7AAC",
44              "indexBuildStatus": "COMPLETED",
45              "indexBuildType": "INCREMENTAL",
46              "indexId": "0axxx00000000RRAAY",
47              "message": "There are no changes for the partial update.",
48              "numberOfChanges": 0
49            },
50            {
51              "catalogSnapshotTime": "2024-11-06T12:07:32.000Z",
52              "completionTime": "2024-11-06T12:09:02.000Z",
53              "createdById": "005xx000001X7x7AAC",
54              "indexBuildStatus": "COMPLETED_WITH_ERRORS",
55              "indexBuildType": "FULL",
56              "message": "Warning: Product errors found.",
57              "numberOfChanges": 1
58            }
59          ],
60          "indexType": "PRODUCT",
61          "lastBuildStatus": "IN_PROGRESS",
62          "venueId": "1D6xx0000004C92CAE"
63        }
64      ]
65    }
66  ]

Properties

Property Name	Type	Description	Filter Group and Version	Available Version
`activationDate`	String	Activation date of the snapshot.	Small, 62.0	62.0
`activationStatus`	String	Activation status of the snapshot. Valid values are `NONE`, `ACTIVE`—Snapshot is in active status, or `EXPIRED`—Snapshot is in expired status.	Small, 62.0	62.0
`activationType`	String	Activation type of the snapshot. Valid values are `IMMEDIATE`—Snapshot is activated immediately after a successful build.	Small, 62.0	62.0
`id`	String	ID of the snapshot.	Small, 61.0	61.0
`snapshotIndexes`	Snapshot Index[]	List of indexes created in the snapshot.	Small, 62.0	62.0