Skip to main content

 Web service API

How to use PageSeeder's Web service API

rename group

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

com.pageseeder.group.RenameGroup

Description

Launch a rename thread for the group.

Invoking this service starts an Asynchronous process.

The thread does the following

  1. Update the group name, project template and visibility (control group) if not 'public'.
  2. Rename the group default folder path in the file system.
  3. Update all URIs and group folders which start with the group default folder path.

Parameters

NameDescriptionRequiredTypeDefault value
nameThe new name of the groupyesstring

Permission

This service requires administrator.

Response

This service returns the following XML:

<group-renaming>
  <thread ...> ... </thread>
</group-renaming>

Error Handling

CodeCause / Description
0x1101Illegal character in group name
0x1103Group name in use
0x1102Documents folder already exists
0x1106Parent project missing or is a group
0x1110Template folder already exists
0x110FCannot change a group to a project or a project to a group
Created on , last edited on