Download (Snapshots)

URL:: https://<root>/notebooks/snapshots/download
Methods:: POST
Required Capability:: Access allowed with "Create and edit notebooks" privilege
Version Introduced:: 11.4

Description

The download operation allows you to download a notebook snapshot. The snapshot is returned as a JSON representation of the notebook. Only the owner of a notebook item is allowed to download a snapshot.

Request parameters

Parameter Details

Parameter	Details
`itemId` (Required)	The item ID of the notebook with the snapshot you want to download.
`resourceKeys` (Required)	The resource key of the snapshot to download. Example: Use dark colors for code blocksCopy `1 resourceKeys=snapshot-0f146a4ba1964327b396b9be5f1042ed.json`
`f`	The response format. The default response format is `html`. Values: `html` \| `json` \| `pjson`

itemId

(Required)

The item ID of the notebook with the snapshot you want to download.

resourceKeys

(Required)

The resource key of the snapshot to download.

Example:

Use dark colors for code blocksCopy
 resourceKeys=snapshot-0f146a4ba1964327b396b9be5f1042ed.json

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 download operation:

Use dark colors for code blocksCopy
POST /context/admin/notebooks/snapshots/download HTTP/1.1
Host: organization.domain.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []

itemId=2ff206ba534541428409e327d03588d1&resourceKey=snapshot-0f146a4ba1964327b396b9be5f1042ed.json&f=pjson&token=<token>