Skip To Content
ArcGIS Developer
Dashboard

Create Snapshot

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 is allowed to have up to five snapshots. Once the maximum limit of snapshots is reached, creation of additional snapshots will fail 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. A user with administrative privileges can modify the default limit of snapshots by configuring the maxSnapshotsPerNotebookItem system property.

Request parameters

ParameterDetails
itemId

(Required)

Item ID of notebook for which a snapshot is created. If notebookJSON is not provided, the current saved state of the notebook will be stored as the snapshot for the item

name

(Required)

A unique name for the snapshot.

description

(Optional)

A description of the snapshot.

notebookJSON

(Optional)

By default, a snapshot will be created from the item currently saved to Item. However, it is possible to pass in a notebook JSON to save as the snapshot.

privateAccess

(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: true | false

f

(Optional)

The response format. The default response format is html.

Values: html | json | pjson

Example usage

https://notebookserver.domain.com:11443/arcgis/admin/notebooks/snapshots/create?f=json
&name=Snapshot_1
&description=This+is+snapshot+1+
&notebookJSON=<{notebook JSON}>

JSON Response syntax

{
  "snapshotResourceKey": "<snapshotResourceKey>",
  "status": "success|failure"
}

JSON Response example

{
  "snapshotResourceKey": "snapshot-eaafdf1d95c248e6bbf49543b6300975.json",
  "status": "success"
}