- URL: https://<notebookserveradmin>/notebooks
- Required Capability:Administrator or Create and Edit ArcGIS Notebooks
- Related Resources:Notebook, Open Notebook, Execute Notebook, Update Default Template, Restore Default Template, Runtimes, Snapshots
- Version Introduced:10.7
Description
This resource provides a list of all ArcGIS Notebooks currently running on your ArcGIS Notebook Server site. The unique ID of each notebook is shown, with the user who owns it in parentheses.
Request parameters
| Parameter | Details |
|---|---|
| start | The number of the first entry in the result set response. The index number is 1-based. The default value is 1. Example: |
| num | The maximum number of results that will be included in the result set response. The default value is 10, and the maximum allowed value is 100. Nota:The actual number of returned results may be less than the num value. This occurs when the number of results remaining after start is less than num. Example: |
| f | The response format. The default response format is html. Values: html | json | pjson |
JSON Response syntax
{
"total" : <total number of results>,
"notebooks": [
{
"itemId": "<notebook 1 itemId>",
"notebookUrl": "<notebook 1 url>",
"dateLastActivity": "<epoch time in milliseconds>",
"id": "<notebook1 id>",
"containerId": "<containerId>",
"username": "<notebook 1 owner username>"
},
{
"itemId": "<notebook 2 itemId>",
"notebookUrl": "<notebook 2 url>",
"dateLastActivity": "<epoch time in milliseconds>",
"id": "<notebook2 id>",
"containerId": "<containerId>",
"username": "<notebook 2 owner username>"
}
],
"num": < maximum number of results to be included in the result set response >,
"start" : <The number of the first entry in the result set response>
}JSON Response example
{
"total": 3,
"notebooks": [
{
"itemId": "b57954c0e08b4f7db8fa4a80d8f1ab95",
"notebookUrl": "/notebooks/84fb308295fc413cb7d6680c266cfab5/notebooks/b57954c0e08b4f7db8fa4a80d8f1ab95.ipynb",
"dateLastActivity": "1548975258795",
"id": "22f1b51c4cd3451e8c026eacab1114aa",
"containerId": "84fb308295fc413cb7d6680c266cfab5",
"username": "joe"
},
{
"itemId": "5bfbb4aaa221443db4e2ddbadccafb3d",
"notebookUrl": "/notebooks/4f8d50afb143459a8b3adee800acee3f/notebooks/5bfbb4aaa221443db4e2ddbadccafb3d.ipynb",
"dateLastActivity": "1548976247002",
"id": "2c914a07f80d49b7ab876d0e4c197e6c",
"containerId": "4f8d50afb143459a8b3adee800acee3f",
"username": "jane"
},
{
"itemId": "5bfbb4aaa221443db4e2ddbadccafb3d",
"notebookUrl": "/notebooks/84fb308295fc413cb7d6680c266cfab5/notebooks/5bfbb4aaa221443db4e2ddbadccafb3d.ipynb",
"dateLastActivity": "1548975767414",
"id": "33a48f6f1a7c45b5a5bb6c59ab369292",
"containerId": "84fb308295fc413cb7d6680c266cfab5",
"username": "joe"
}
],
"num": 10,
"start": 1
}