Container Notebook

URL:
https://<notebookserveradmin>/system/containers/<containerId>/notebooks/<notebookID>
Methods:
GET
Required Capability:
Administrator or Create and Edit
Version Introduced:
10.9

Description

This resource contains a description of a specific notebook's properties.

Request parameters

ParameterDetails

f

The response format. The default response format is html .

Values: html | json | pjson

Response properties

PropertyDetails

id

The notebook's unique ID in your container. Note that this is different from the notebook's portal item ID.

notebookUrl

The unique URL of the notebook's item page, beginning with the /notebooks/ path. The URL is constructed in the following format:

Use dark colors for code blocksCopy
1
https://notebookserver:port/arcgis/admin/notebooks/\<containerID>/notebooks/<itemID>.ipynb

containerId

The ID of the container hosting the notebook.

Username

The user name of the owner of the notebook.

itemId

The unique portal item ID of the notebook. It is included in the notebook URL.

dateLastActivity

The last time the notebook was modified or run, given in milliseconds from epoch, with the current date and coordinated universal time in parentheses.

Example usage

Use dark colors for code blocksCopy
1
https://notebookserver.domain.com:11443/arcgis/admin/system/containers/<containerId>/notebooks/<notebookID>?f=json

JSON Response syntax

Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
{
  "itemId": "<portal item ID>",
  "notebookUrl": "<notebook item URL>",
  "dateLastActivity": "<milliseconds>",
  "id": "<notebook's unique ID>",
  "containerId": "<container's unique ID>",
  "username": "<notebook owner's username>"
}

JSON Response example

Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
{
  "itemId": "525d80c96d5a4915bb5cfff79c851fb1a",
  "notebookUrl": "/notebooks/82hb62d771ec4f8185b6b861b65dc521/notebooks/525d80c96d5a4915bb5cfff79c851fb1a.ipynb",
  "dateLastActivity": "1544488988365",
  "id": "c9ae74cc34b1414bad0618bdb5f54d4d",
  "containerId": "82hb2d771ec4f8185b6b861b65dc521",
  "username": "janedoe"
}

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.