- URL:
- https://<notebookserveradmin>/notebooks/snapshots/create
- Methods:
POST
- Required Capability:
- Administrator or Create and Edit
- Version Introduced:
- 10.9
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
system property.
Request parameters
Parameter | Details |
---|---|
(Required) | The item ID of the notebook for which a snapshot is created. If no |
(Required) | A unique name for the snapshot. |
(Optional) | A description of the snapshot. |
(Optional) | By default, a snapshot will be created from the item currently saved as the |
(Optional) | A Boolean property. When set to true, the snapshot will be accessible only to the owner of the notebook item. When set to false, the snapshot will be accessible to users with whom the notebook is shared. Values: |
| Supported in ArcGIS Notebook Server 11.0. Indicates whether the snapshot is intended to be used to create or overwrite a web tool. This snapshot will not count toward the default snapshot limit of five. A maximum of two notebook snapshots are allowed. Use the Values: |
(Optional) | The response format. The default response format is Values: |
Example usage
https://notebookserver.domain.com:11443/arcgis/admin/notebooks/snapshots/create?f=json
&name=Snapshot_1
&description=This+is+snapshot+1+
¬ebookJSON=<{notebook JSON}>
JSON Response syntax
{
"snapshotResourceKey": "<snapshotResourceKey>",
"status": "success|failure"
}
JSON Response example
{
"snapshotResourceKey": "snapshot-eaafdf1d95c248e6bbf49543b6300975.json",
"status": "success"
}