Web service API

How to use PageSeeder's Web service API

create groupfolder

/groups/{group}/groupfolders/create [POST]

com.pageseeder.groupfolder.CreateGroupFolder

This service is deprecated since version 5.8900

Description

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

Deprecation warning!

This URL has been deprecated in PageSeeder 5.9 and has been scheduled to be removed.

Use Service: /groups/{group}/groupfolders [POST] instead.

 

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
url the url of the group folder (/* suffix will be added automatically) yes string
editable whether URIs should be editable by this group no boolean false

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
0x1401 If the url is invalid
0x1402 If the host is unknown
0x1403 If the group folder URL already exists in group

Created on , last edited on