- URL:
- https://<notebookserveradmin>/notebooks/openNotebook
- Methods:
POST- Required Capability:
- Administrator or Create and Edit
- Version Introduced:
- 10.7
Description
The open operation moves a notebook into active status in a container. The operation request can enclose any unique notebook ID; you can specify the ID of an existing notebook to open it, or leave all ID fields blank to create and open a new notebook.
Request parameters
| Parameter | Details |
|---|---|
| The portal item ID of the notebook you want to open. This is required if |
| The ID of the notebook runtime (Standard, Advanced, or Custom) to be used when opening a notebook. |
| The notebook JSON. This is used when saving an existing notebook as a new notebook and when opening the new notebook item. |
| The response format. The default response format is Values: |
JSON Response syntax
{
"jobId": "jobId",
"jobUrl": "jobUrl",
"status": "success|failure"
}JSON Response example
{
"jobId": "jf9322f05-6b31-4bdd-8d42-be471fe904eb",
"jobUrl": "https://mserver.domain.com/notebookserver/admin/system/jobs/jf9322f05-6b31-4bdd-8d42-be471fe904eb",
"status": "success"
}