- URL:
- https://<root>/notebooks/snapshots/list
- Methods:
POST- Required Capability:
- Access allowed with "Create and edit notebooks" privilege
- Version Introduced:
- 11.4
Description
The list operation allows you to list all snapshots associated with a notebook item. It returns metadata associated with snapshots, such as name, description, and notebook runtime information.
By default, unless the snapshot was created with the private set to false, only the owner of a notebook item is allowed to list the snapshots associated with that notebook item.
Request parameters
| Parameter | Details |
|---|---|
(Required) | The item ID of the notebook to list snapshots from. |
| The response format. The default response format is Values: |
Example usage
The following is a sample POST request for the list operation:
POST /context/admin/notebooks/snapshots/list HTTP/1.1
Host: organization.domain.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []
itemId=2ff206ba534541428409e327d03588d1&f=pjson&token=<token>JSON Response example
{
"snapshots": [
{
"resourceKey": "snapshot-0f146a4ba1964327b396b9be5f1042ed.json",
"created": "1713916056583",
"properties": {
"name": "Snapshot_1",
"description": "This is Snapshot 1",
"runtime": {
"notebookRuntimeName": "ArcGIS Notebook Python 3 Standard",
"notebookRuntimeVersion": "10.0"
}
}
},
{
"resourceKey": "snapshot-4h046a4ba1964327b396b9be5f1046uj.json",
"created": "1713916056585",
"properties": {
"name": "Snapshot_2",
"description": "This is Snapshot 2",
"runtime": {
"notebookRuntimeName": "ArcGIS Notebook Python 3 Standard",
"notebookRuntimeVersion": "10.0"
}
}
}
],
"total": 2,
"status": "success"
}