Open Notebook

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

Description

The openNotebook operation moves a notebook into active status in a notebook deployment. The operation request can enclose any unique notebook ID. You can specify the ID of an existing notebook item to open it.

Request parameters

Parameter	Details
`itemId`	The portal item ID of the notebook you want to open. This is required if `templateNotebook` is not provided.
`templateId`	The `itemId` value of a Notebook item.
`notebookRuntimeId`	The ID of the notebook runtime (Standard, Advanced, or Custom) to be used when opening a notebook.
`templateNotebook`	The notebook JSON. This is used when saving an existing notebook as a new notebook and when opening the new 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 openNotebook operation:

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

itemId=bf84530f0fd3482bac8bf1bf2f4a0dae&templateId=&notebookRuntimeId=&templateNotebook=&f=pjson&token=<token>

JSON Response syntax

Use dark colors for code blocksCopy
{
  "jobId": <Job Id>,
  "jobUrl": <Job URL,
  "status": "Success|Failure"
}

JSON Response example

Use dark colors for code blocksCopy
{
  "jobId": "j31316620-1a66-436b-b45d-a25ba574f44a",
  "jobUrl": "https://organization.domain.com/context/admin/jobs/j31316620-1a66-436b-b45d-a25ba574f44a",
  "status": "success"
}