Web service API

How to use PageSeeder's Web service API

create folder

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

com.pageseeder.uri.CreateFolder

Description

Creates a new folder under the specified destination.

Parameters

NameDescriptionRequiredTypeDefault value
nameName of folder to createmaybestring
parentfolderName of parent folder in the default group URI (required if request has no uri and url and parenturl are not specified)maybestring
descriptionDescription of new foldernostring
docidFolder IDnostring
labelsComma separated list of folder labelsnolabel
titleDisplay title of new folder. Max 255 characters.nostring

Permission

Undocumented permissions requirements.

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> 

If name is invalid, it is changed automatically to a character valid, the return is:

<folder-creation renamed="true" original-name="ne,/.\@dcdd">
   <uri id="97" 
      scheme="http" 
      host="localhost"
      port="80" 
      path="/ps/pub/a/ne%2C_._%40dcdd" 
      decodedpath="/ps/pub/a/ne,_._@dcdd"
      external="false" 
      mediatype="folder" 
      created="2017-02-27T08:24:47+11:00"
      modified="2017-02-27T08:24:47+11:00">
     <displaytitle>ne,_._@dcdd</displaytitle>
   </uri>
</folder-creation>

Error handling

CodeCause / 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)

Created on , last edited on