Create (Snapshots)

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 maxSnapshotsPerNotebookItem property using the Update operation.

Request parameters

ParameterDetails

itemId

(Required)

The item ID of the notebook for which a snapshot is created. If no value is provided for the notebookJSON parameter, 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

A description of the snapshot.

notebookJSON

By default, a snapshot will be created from the item currently saved as the itemID value. However, you can pass in a notebook JSON to save as the snapshot.

privateAccess

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

The response format. The default response format is html.

Values: html | json | pjson

Example usage

The following is a sample POST request for the create operation:

1
2
3
4
5
6
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&notebookJSON=&privateAccess=false&f=pjson&token=<token>

JSON Response example

1
2
3
4
{
  "snapshotResourceKey": "snapshot-eaafdf1d95c248e6bbf49543b6300975.json",
  "status": "success"
}

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.

You can no longer sign into this site. Go to your ArcGIS portal or the ArcGIS Location Platform dashboard to perform management tasks.

Your ArcGIS portal

Create, manage, and access API keys and OAuth 2.0 developer credentials, hosted layers, and data services.

Your ArcGIS Location Platform dashboard

Manage billing, monitor service usage, and access additional resources.

Learn more about these changes in the What's new in Esri Developers June 2024 blog post.

Close