- URL:
- https://<root>/notebook/<notebookID>
- Methods:
GET- Required Capability:
- Access allowed with either the "Create and edit notebooks", "Servers", or "Security and infrastructure" privileges
- Version Introduced:
- 11.4
Description
The resource for a notebook returns the notebook's properties, such as its unique ID, the notebook owner's username, and the timestamp of when it was last revised.
Request parameters
| Parameter | Details |
|---|---|
| The response format. The default format is Values: |
Example usage
The following is a sample request URL used to access a notebook resource:
https://organization.domain.com/context/admin/notebooks/c493f410b16c42f895e47c8163b14907?f=pjsonJSON Response syntax
{
"itemId": "<notebook 1 itemId>",
"notebookUrl": "<notebook 1 url>",
"itemTitle": "<Notebook Title 1>",
"dateLastActivity": "<epoch time in milliseconds>",
"id": "<notebook1 id>",
"notebookDeploymentId": "<notebook1 deployment id>",
"username": "<notebook 1 owner username>",
"revision": "<revision number>"
}JSON Response example
{
"itemId": "bf84530f0fd3482bac8bf1bf2f4a0dae",
"notebookUrl": "/notebooks/5189b5c7a09544f3b64f562158ad55a9/notebooks/bf84530f0fd3482bac8bf1bf2f4a0dae.ipynb",
"itemTitle": "Notebook Title 1",
"dateLastActivity": 1713897499743,
"id": "c493f410b16c42f895e47c8163b14907",
"notebookDeploymentId": "5189b5c7a09544f3b64f562158ad55a9",
"username": "jane",
"revision": 1713896888618
}