Skip to content
URL:
https://dataaccess/notebookworkspace/createFolder
Methods:
POST
Version Introduced:
11.5

Access requirements

Required privileges

The Enterprise Administrator API requires privilege-based access. An administrator must be assigned a specific user privilege, or role, to access any given endpoint. Listed below are the user privileges or roles an administrator can be assigned that provides access to this endpoint. If multiple privileges are listed, only one needs to be assigned to gain access.



To access notebook-related endpoints, administrators must be assigned a custom role that includes any of the privileges listed above as well as the Create and edit notebooks privilege.

Tokens

This API requires token-based authentication. A token is automatically generated for administrators who sign in to the Enterprise Administrator API directory's HTML interface. Tokens generated in this way are stored for the entirety of the session.

Those accessing the API directory outside of the HTML interface will need to acquire a session token from the generateToken operation in the Enterprise Directory API. For security reasons, all POST requests made to the Enterprise Administrator API must include a token in the request body.


Learn how to generate a token

Description

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

Request parameters

ParameterDetails

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

Example usage

The following are example requests for the createFolder operation.

Use dark colors for code blocksCopy
1
2
3
4
5
6
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

JSON Response syntax

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

JSON Response example

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

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