- URL:
- https://<root>/notebooks/snapshots/restore
- Methods:
POST- Required Capability:
- Access allowed with "Create and edit notebooks" privilege
- Version Introduced:
- 11.4
Description
The restore operation allows you to restore a notebook snapshot for a notebook item. Only the owner of a notebook is allowed to restore from a snapshot.
Request parameters
| Parameter | Details |
|---|---|
(Required) | The item ID of the notebook to list snapshots from. |
(Required) | The resource key of the snapshot to restore. Example: |
| A title for the snapshot preserved as part of the restore. |
| The option of whether to preserve the current notebook item file as a snapshot as part of the restore. Values: |
| A description for the snapshot preserved as part of the restore. Values: |
| The response format. The default response format is Values: |
Example usage
The following is a sample POST request for the restore operation:
POST /context/admin/notebooks/snapshots/restore HTTP/1.1
Host: organization.domain.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []
itemId=2ff206ba534541428409e327d03588d1&resourceKey=snapshot-0f146a4ba1964327b396b9be5f1042ed.json&title=&preserveCurrentAsSnapshot=false&description=false&f=pjson&token=<token>JSON Response example
{
"status": "success"
}