Create Folder

URL:: https://dataaccess/notebookworkspace/createFolder
Methods:: POST
Required Capability:: Access allowed with the "Create and edit notebooks" privilege
Version Introduced:: 11.5

Description

Attention

Accessing the dataaccess resource, and any of its sub-operations and resources, redirects users to the Notebook Services Admin API Directory. These endpoint are accessible using the following URL pattern:

Use dark colors for code blocksCopy
https://organization.example.com/<context>/notebooks/admin/dataacess/<....>

To return to the Enterprise Admin API directory, users should modify their URLs in the following way:

Use dark colors for code blocksCopy
https://organization.example.com/<context>/admin

The createFolder operation allows you to create a folder in your /arcgis/home notebook workspace directory.

Request parameters

Parameter Details

Parameter	Details
`folderName` (Required)	The name of the folder to be created. The name must be unique. The `createFolder` operation does nothing if you use the name of an existing folder. The folder can be created in a subdirectory by prefixing a folder path to the `folderName` parameter value. Example Use dark colors for code blocksCopy `1 2 3 4 5 //Create a folder in /arcgis/home folderName=folder1 //Create a folder in a subdirectory folderName=folder_1/folder_1_2`
`f`	The response format. The default response format is `html`. Values: `html` \| `json` \| `pjson`

folderName

(Required)

The name of the folder to be created. The name must be unique. The createFolder operation does nothing if you use the name of an existing folder. The folder can be created in a subdirectory by prefixing a folder path to the folderName parameter value.

Example
Use dark colors for code blocksCopy
//Create a folder in /arcgis/home
folderName=folder1

//Create a folder in a subdirectory
folderName=folder_1/folder_1_2

f

The response format. The default response format is html.

Values: html | json | pjson

Example usage

The following are example requests for the createFolder operation.

Use dark colors for code blocksCopy
POST /<context>/notebooks/admin/dataaccess/notebookworkspace/createFolder HTTP/1.1
Host: organization.example.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []

folderName=folder1&f=pjson&token=PuuxoDV8HzHD1GxXUDpgHDeItErtl9Wr6rbULdhXHVUnGsjZ2hI1j1cPmnDEN1UnUfDqrNr2AuviTe5OkBumXsPlwSCrKw_ZVM1vczv2ziRESyz2PEAAhfsf71EyKIEGe7wW1z7hN_aLIjTekcdUbs-xtUAMZjEKHDRxT85NlfWqQghOy6o5XE54P8nnmdhllY6IfdtqeRtOYfFLoCBGCmOFV8diNVk4CxW3MMnzelDAGuRpN-Bru-vcYTY-7Or9

Use dark colors for code blocksCopy
POST /<context>/notebooks/admin/dataaccess/notebookworkspace/createFolder HTTP/1.1
Host: organization.example.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []

folderName=folder_1/folder_1_2&f=pjson&token=PuuxoDV8HzHD1GxXUDpgHDeItErtl9Wr6rbULdhXHVUnGsjZ2hI1j1cPmnDEN1UnUfDqrNr2AuviTe5OkBumXsPlwSCrKw_ZVM1vczv2ziRESyz2PEAAhfsf71EyKIEGe7wW1z7hN_aLIjTekcdUbs-xtUAMZjEKHDRxT85NlfWqQghOy6o5XE54P8nnmdhllY6IfdtqeRtOYfFLoCBGCmOFV8diNVk4CxW3MMnzelDAGuRpN-Bru-vcYTY-7Or9

JSON Response syntax

Use dark colors for code blocksCopy
{"status": "<success | failure>"}

JSON Response example

Use dark colors for code blocksCopy
{"status": "success"}