Web service API

How to use PageSeeder's Web service API

edit groupfolder

/groups/{group}/groupfolders/{id} [PATCH]

com.pageseeder.groupfolder.EditGroupFolderDeprecated

This service is deprecated since version 5.9400

Description

Edit the group folder, also known as "Group URI", specified by the id parameter.

Note

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

This service is used to make a group folder editable.

Parameters

NameDescriptionRequiredTypeDefault value
editableWhether URIs should be editable by group.noboolean

Permission

Permissions requirements to be updated.

Response

If the update was successful, this service returns the updated group folder as a <groupfolder> element wrapped in a <groupfolder-modification>.

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

Error Handling

CodeCause / Description
0x1406If the group folder id not found
0x1408If the group folder id in another group

Created on , last edited on