createFolder

Function
import { createFolder } from "@esri/arcgis-rest-portal";
//
createFolder({
  title: 'Map Collection',
  authentication: userSession
})
  .then(response)

Create a folder. See the REST Documentation for more information.

Parameters

Parameter Type Default Notes
requestOptions Required ICreateFolderOptions

Options for the request

Available requestOptions

Property Type Notes
title string

Name of the folder to create.

authentication Inherited UserSession

A session representing a logged in user.

fetch Optional Inherited function(input: RequestInfo, init: RequestInit) : Promise<Response>

The implementation of fetch to use. Defaults to a global fetch.

folderId Optional Inherited string

Id of the folder to house the item.

headers Optional Inherited [key: string]: any

Additional Headers to pass into the request.

httpMethod Optional Inherited HTTPMethods

The HTTP method to send the request with.

maxUrlLength Optional Inherited number

If the length of a GET request's URL exceeds maxUrlLength the request will use POST instead.

owner Optional Inherited string

The owner of the item. If this property is not present, item.owner will be passed, or lastly authentication.username.

params Optional Inherited IParams

Additional parameters to pass in the request.

portal Optional Inherited string

Base url for the portal you want to make the request to. Defaults to 'https://www.arcgis.com/sharing/rest'.

rawResponse Optional Inherited boolean

Return the raw response

Returns

A Promise that resolves with folder details once the folder has been created

Property Type Notes
folder {
id:
string
title:
string
username:
string
}

Information about created folder: its alphanumeric id, name, and owner's name.

success boolean

Success or failure of request.


Function defined in packages/arcgis-rest-portal/src/items/create.ts:46