Afteroffice.com

Home > Developer

Storage API : NewFolder

NewFolder

Script path: /storage/bin/api/newfolder.cgi

Description: Create a new folder and optionally set a description for it.

INPUT (via GET or POST)

Mandatory parameters are: sid, path
Optional parameters are: description

sid session id of the login user. [mandatory]
path path to the new folder [mandatory]

Please refer to [How to specify a path].

The new folder must not already exist, but the folder to contain it
(its parent folder) must exist.

For new folder names, refer to [Name restriction]

e.g.
path=/Company Share/Archive/Data/ - create new folder named Data.
description = <a_descriptive_string>
This is optional, and will be left blank if unspecified. Currently the length of the description is limited to 80 characters. (Another limitation is that it cannot contain "::" <back-to-back-colon> in the string. Such patterns will be removed.)


OUTPUT (content-type: text/plain)

Successful return:

true <newline>


Unsuccessful return:

false <tab> <error message> <newline>

e.g.

false <TAB> New name is invalid. (illegal character, too long, etc.)