Web service API

How to use PageSeeder's Web service API

groupfolders

/groups/{group}/groupfolders [POST]

com.pageseeder.groupfolder.CreateGroupFolder

Description

Create a new group folder, also known as "Group URI",  with the URL specified in the request.

Note

The url parameter can end with the suffix "/*" but if it does not then the suffix will be added automatically.

Note

Default group folders (i.e. /ps/[project]/[group]/*) are always editable by group.

Parameters

NameDescriptionRequiredTypeDefault value
urlThe URL of the group folder (/* suffix will be added automatically)yesstring
editableWhether URIs should be editable by this groupnobooleanfalse

Permission

Only Administrators can invoke this service.

Response

If successful, the group folder that was created is returned as <groupfolder> element wrapped in a <groupfolder-creation> element.

<groupfolder-creation>
   <groupfolder id="[groupuri id]"
                scheme="[scheme]"
                host="[host]"
                port="[port]"
                path="[path]"
                external="[true|false]"
                editable="[true|false]"
                public="[true|false]"
                [sharing="[private|shared]"] />
   </groupfolder>
</groupfolder-creation>

Error Handling

CodeCause / Description
0x1401If the url is invalid
0x1402If the host is unknown
0x1403If the group folder URL already exists in group
0x0202Goup not found.

Created on , last edited on