Skip to main content

 Services

Web services from /about to /webhooks

create folder forurl

/members/{member}/groups/{group}/folders/forurl [POST]

Description

Creates a new folder under the specified destination.

Parameters

NameDescriptionRequiredTypeDefault
nameName of folder to create (required if url not specified)maybestring
parenturlURL of parent URI (required if  url not specified)maybeurl
urlURL of target URI (required if parenturl not specified)maybeurl
descriptionDescription of new foldernostring
docidFolder IDnostring
labelsComma-separated list of folder label valuesnostring
titleDisplay title of new foldernostring

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

CodeCause / Description
0x1201Illegal character in filename
0x1216Invalid destination
0x120AInvalid Document ID
0x1209Existing Document ID
0x1211Existing URI
0x1217Two contradictory parameters have been specified (url and name or url and parenturl or url and parentfolder or parenturl and parentfolder)
Created on , last edited on