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 create.yesstring
parentfolderName of parent folder in the default group URI.yesstring
descriptionDescription of new folder.nostring
docidFolder ID.nostring
labelsComma-separated list of folder label values.nolabel
titleDisplay title of new folder. Max 255 characters.nostring

Permission

Permissions requirements to be updated.

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
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