- URL:
- https://<root>/notebooks/deployments/<deploymentId>/notebooks/<notebookId>
- Methods:
GET
- Operations:
- Close Notebook
- Required Capability:
- Access allowed with "Create and edit notebooks" privilege
- Version Introduced:
- 11.4
Description
The resource for an individual notebook in a deployment object returns a description of the notebook's properties.
Request parameters
Parameter | Details |
---|---|
| The response format. The default response format is Values: |
Response properties
Property | Details |
---|---|
| The unique portal item ID of the notebook. It is included in the notebook URL. |
| The unique URL of the notebook's item page, beginning with the |
| The unique portal item title of the notebook. |
| The last time the notebook was modified or run, given in milliseconds from epoch, with the current date and coordinated universal time in parentheses. |
| The notebook's unique ID in your notebook deployment. |
| The user name of the owner of the notebook. |
Example usage
The following is a sample request URL used to access an individual notebook resource:
https://organization.domain.com/context/admin/notebooks/deployments/e243d523-40a7-4c37-8266-9e7b5bc0c229/notebooks/4565c98f-e815-4ef5-a813-63e8ba22e41b?f=pjson
JSON Response example
{
"itemId": "2ff206ba534541428409e327d03588d1",
"notebookUrl": "/notebooks/fa80941bbca9404ab837c5967c80c07a/notebooks/2ff206ba534541428409e327d03588d1.ipynb",
"itemTitle": "NBA-2",
"dateLastActivity": 1713927612251,
"id": "3c9b5f774a2f418dadf48c7f24a9ef1a",
"notebookDeploymentId": "fa80941bbca9404ab837c5967c80c07a",
"username": "portaladmin",
"revision": 1713915973510
}