Register Server Directory

URL:: https://<notebookserveradmin>/admin/system/directories/register
Methods:: POST
Required Capability:: Administrator
Version Introduced:: 10.7

Description

The register operation registers a new data directory from your local machine with the ArcGIS Notebook Server site. Registering a local folder as a data directory allows notebook authors to work with files in the folder.

Request parameters

Parameter	Details
`name`	The name of the directory.
`path`	The full path to the directory on your machine.
`type`	Registers a new data directory from your local machine with the ArcGIS Notebook Server site. ArcGIS Notebook Server directories can be one of four types: `DATA` , `JOBS` , `WORKSPACE` , or `OUTPUT` . When registering a data directory, use the `DATA` type. Other directory types will be automatically registered when the notebook server site is created. Values: `DATA`
`f`	The response format. The default is `html` . Values: `html` \| `json` \| `pjson`

Response properties

Property	Details
`status`	Indicates success or failure when registering the directory.

JSON Response syntax

Use dark colors for code blocksCopy
{
  "path": "path",
  "name": "name",
  "id": "some_id",
  "type": "DATA"
}

JSON Response example

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