Notebooks

URL:: https://<root>/notebooks
Methods:: GET
Operations:: Open Notebook, Execute notebook, Update Default Template, Restore Default Template
Child Resources:: Deployments, Jobs, Runtimes, Snapshots, Configuration, Snippets, Workspaces
Required Capability:: Access allowed with "Create and edit notebooks" privilege
Version Introduced:: 11.4

Description

The notebooks resource provides a list of all ArcGIS Notebooks currently running in an organization. The returned information includes each notebook's unique ID and the username of the notebook's owner.

Request parameters

Parameter	Details
`f`	The response format. The default format is `html`. Values: `html` \| `json` \| `pjson`

Example usage

The following is a sample request URL used to access the notebooks resource:

Use dark colors for code blocksCopy
https://organization.domain.com/context/admin/notebooks?f=pjson

JSON Response syntax

Use dark colors for code blocksCopy
{
  "operations": [
    "openNotebook",
    "executeNotebook",
    "updateDefaultTemplate",
    "restoreDefaultTemplate"
  ],
  "notebooks": [
    {
      "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>"
    },
    {
      "itemId": "<notebook 2 itemId>",
      "notebookUrl": "<notebook 2 url>",
      "itemTitle": "<Notebook Title 2>",
      "dateLastActivity": "<epoch time in milliseconds>",
      "id": "<notebook1 id>",
      "notebookDeploymentId": "<notebook2 deployment id>",
      "username": "<notebook 2 owner username>",
      "revision": "<revision number>"
    }
  ]
  "resources": [
    "deployments",
    "jobs",
    "runtimes",
    "snapshots",
    "configuration",
    "snippets",
    "workspaces"
  ]
}

JSON Response example

Use dark colors for code blocksCopy
{
  "operations": [
    "openNotebook",
    "executeNotebook",
    "updateDefaultTemplate",
    "restoreDefaultTemplate"
  ],
  "notebooks": [
    {
      "itemId": "bf84530f0fd3482bac8bf1bf2f4a0dae",
      "notebookUrl": "/notebooks/5189b5c7a09544f3b64f562158ad55a9/notebooks/bf84530f0fd3482bac8bf1bf2f4a0dae.ipynb",
      "itemTitle": "Notebook Title 1",
      "dateLastActivity": 1713897499743,
      "id": "c493f410b16c42f895e47c8163b14907",
      "notebookDeploymentId": "5189b5c7a09544f3b64f562158ad55a9",
      "username": "jane",
      "revision": 1713896888616
    },
    {
      "itemId": "2ff206ba534541428409e327d03588d1",
      "notebookUrl": "/notebooks/4f8d50afb143459a8b3adee800acee3f/notebooks/2ff206ba534541428409e327d03588d1.ipynb",
      "itemTitle": "Notebook Title 2",
      "dateLastActivity": 1713897636436,
      "id": "4409daa27b9447f8b85b426b117d8598",
      "notebookDeploymentId": "4f8d50afb143459a8b3adee800acee3f",
      "username": "joe",
      "revision": 1713897615946
    }
  ],
  "resources": [
    "deployments",
    "jobs",
    "runtimes",
    "snapshots",
    "configuration",
    "snippets",
    "workspaces"
  ]
}