Notebook Server Directory

URL:
https://<notebookserveradmin>/system/directories/<dir>
Methods:
GET
Operations:
Unregister Notebook Server Directory
Required Capability:
Administrator or Create and Edit
Version Introduced:
10.7

Description

ArcGIS Notebook Server uses server directories to store the user content associated with notebooks. In addition, some directories contain configurations that power the notebooks.

There are four kinds of directories, each of which plays a specific role in server operations: the workspace directory, the data directory, the output directory, and the system directory.

You can register a local directory as a data directory, making it available in ArcGIS Notebooks running in your site.

Request parameters

ParameterDetails

f

The response format. The default response format is html .

Values: html | json | pjson

JSON Response syntax

Use dark colors for code blocksCopy
1
2
3
4
5
6
{
  "path": "path",
  "name": "name",
  "id": "some_id",
  "type": "DATA"
}

JSON Response example

The following example demonstrates the response returned for a data directory on a Windows machine:

Use dark colors for code blocksCopy
1
2
3
4
5
6
{
  "path": "d:\\data",
  "name": "EarthquakesData",
  "id": "a18ade52-5ad1-43e9-aa3b-cc1a371bd45d",
  "type": "DATA"
}

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