Convert to Item

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

Description

The convertToItem operation allows the owner of a notebook to convert a snapshot to a new notebook item.

Request parameters

ParameterDetails

itemId

(Required)

The item ID of the notebook with the snapshot to convert to an item.

resourceKey

(Required)

The resource key of the snapshot to convert.

Example:

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

notebookTitle

(Required)

A title for the newly created notebook item.

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

Use dark colors for code blocksCopy
1
2
3
4
5
6
POST /context/admin/notebooks/snapshots/convertToItem HTTP/1.1
Host: organization.domain.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []

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

JSON Response example

Use dark colors for code blocksCopy
1
2
3
4
{
  "itemId": "7f95c2b30f4e43579bb2964bb4e352ac",
  "status": "success"
}

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