- URL:
- https://<root>/notebooks/snapshots/create
- Methods:
POST- Required Capability:
- Access allowed with "Create and edit notebooks" privilege
- Version Introduced:
- 11.4
Description
The create operation allows you to create a point-in-time, full snapshot of a notebook. Notebook snapshots are full copies of the notebook JSON preserved as a resource associated with the notebook item. By default, a notebook can have up to five snapshots. Once the maximum limit of snapshots is reached, additional snapshots cannot be created until one or more existing snapshots is deleted. Snapshots can only be created by the owner of a notebook item. Snapshots cannot be created for shared notebook items. If you have administrative privileges, you can modify the default limit of snapshots by configuring the max property using the Update operation.
Request parameters
| Parameter | Details |
|---|---|
(Required) | The item ID of the notebook for which a snapshot is created. If no value is provided for the |
(Required) | A unique name for the snapshot. |
| A description of the snapshot. |
| By default, a snapshot will be created from the item currently saved as the |
| A Boolean property. When set to Values: |
| The response format. The default response format is Values: |
Example usage
The following is a sample POST request for the create operation:
POST /context/admin/notebooks/snapshots/create HTTP/1.1
Host: organization.domain.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []
itemId=2ff206ba534541428409e327d03588d1&name=Snapshot_1&description=This+is+Snapshot+1¬ebookJSON=&privateAccess=false&f=pjson&token=<token>JSON Response example
{
"snapshotResourceKey": "snapshot-eaafdf1d95c248e6bbf49543b6300975.json",
"status": "success"
}