create folder forurl
/members/{member}/groups/{group}/folders/forurl [POST]
API Support | Available since | Last updated | Output |
---|---|---|---|
3.3000 | 6.0000 | xml, json |
Description
Creates a new folder under the specified destination.
Parameters
Name | Description | Required | Type | Default |
---|---|---|---|---|
name | Name of folder to create (required if url not specified) | maybe | string | |
parenturl | URL of parent URI (required if url not specified) | maybe | url | |
url | URL of target URI (required if parenturl not specified) | maybe | url | |
description | Description of new folder | no | string | |
docid | Folder ID | no | string | |
labels | Comma-separated list of folder label values | no | string | |
title | Display title of new folder | no | string |
Permission
This service requires contributor or higher.
Response
The XML output follows this format:
<folder-creation [renamed="true" original-name="new:folder"]> <uri id="138614" scheme="https" host="localhost" port="443" folder="true" path="/ps/jb/group1/documents/new_folder" decodedpath="/ps/jb/group1/documents/new_folder" external="false" mediatype="folder" created="2013-12-19T15:14:54+11:00"> <displaytitle>New folder</displaytitle> </uri> </folder-creation>
Error Handling
Code | Cause / Description |
---|---|
0x1201 | Illegal character in filename |
0x1216 | Invalid destination |
0x120A | Invalid Document ID |
0x1209 | Existing Document ID |
0x1211 | Existing URI |
0x1217 | Two contradictory parameters have been specified (url and name or url and parenturl or url and parentfolder or parenturl and parentfolder) |