- URL:
- https://<root>/notebooks/deployments/<deploymentId>/notebooks/<notebookId>
- Methods:
GET- Operations:
- Close Notebook
- Version Introduced:
- 11.4
Access requirements
Required privileges
The Enterprise Administrator API requires privilege-based access. An administrator must be assigned a specific user privilege, or role, to access any given endpoint. Listed below are the user privileges or roles an administrator can be assigned that provides access to this endpoint. If multiple privileges are listed, only one needs to be assigned to gain access.
To access notebook-related endpoints, administrators must be assigned a custom role that includes any of the privileges listed above as well as the Create and edit notebooks privilege.
Tokens
This API requires token-based authentication. A token is automatically generated for administrators who sign in to the Enterprise Administrator API directory's HTML interface. Tokens generated in this way are stored for the entirety of the session.
Those accessing the API directory outside of the HTML interface will need to acquire a session token from the generate operation in the Enterprise Directory API. For security reasons, all POST requests made to the Enterprise Administrator API must include a token in the request body.
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.example.com/<context>/admin/notebooks/deployments/e243d523-40a7-4c37-8266-9e7b5bc0c229/notebooks/4565c98f-e815-4ef5-a813-63e8ba22e41b?f=pjsonJSON Response example
{
"itemId": "2ff206ba534541428409e327d03588d1",
"notebookUrl": "/notebooks/fa80941bbca9404ab837c5967c80c07a/notebooks/2ff206ba534541428409e327d03588d1.ipynb",
"itemTitle": "NBA-2",
"dateLastActivity": 1713927612251,
"id": "3c9b5f774a2f418dadf48c7f24a9ef1a",
"notebookDeploymentId": "fa80941bbca9404ab837c5967c80c07a",
"username": "portaladmin",
"revision": 1713915973510
}