Skip To Content
ArcGIS Developer
Dashboard

Restore Snapshot

Description

The restore operation allows for the restoring of a notebook snapshot for that notebook item. Only the owner of a notebook is allowed to restore from a snapshot.

Request parameters

ParameterDetails
itemId

(Required)

The item ID of the notebook for which to restore a snapshot.

resourceKey

(Required)

The resource key of the snapshot to restore.

Example

snapshot-f58ebdb43b184235a89d0a4acc2ec04b.json
title

(Optional)

A title for the snapshot preserved as part of the restore.

preserveCurrentAsSnapshot

(Required)

The option of whether to preserve the current notebook item file as a snapshot as part of the restore.

Values: true | false

description

(Optional)

A description for the snapshot preserved as part of the restore.

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/restore?f=json
&itemId=5dbacb22922d4ead9b8b065f3ea448b8
&resourceKey=snapshot-05cd1ec64137421f8c2ac975236bf29a.json
&preserveCurrentAsSnapshot=true
&description=This+is+snapshot+created+with+restore

JSON Response syntax

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

JSON Response example

{
  "resourceKey": "snapshot-72c0d3e1ab70440183f11c11e00afb8b.json",
  "status": "success"
}