[Up]: Storage API : 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, ofmt
| 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 e.g. |
| 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.) |
| ofmt |
= null | json | jsonp null is the default, and the legacy "flat" output format is returned. json means the output format is in JSON format jsonp is like json, but in "pretty" form for easier human readability. |
OUTPUT (content-type: text/plain)
Successful return:
true <newline>
Equivalent JSON output would look like the following:
{
"status" : true
}
Unsuccessful return:
false <tab> <error message> <newline>
e.g.
false <TAB> New name is invalid. (illegal character, too long, etc.)
Equivalent JSON output would look like the following:
{
"http_status" : "400 Unable to create folder",
"status" : false,
"errmsg" : "New name is invalid. (illegal character, too long, etc.)"
}