rename group
/members/{member}/groups/{group}/rename [POST]
| API Support | Available since | Last updated | Output |
|---|---|---|---|
| 5.5004 | 6.0000 | xml |
Description
Launch a rename thread for the group.
Invoking this service starts an Asynchronous process.
The thread does the following
- Update the group name, project template and visibility (control group) if not 'public'.
- Rename the group default folder path in the file system.
- Update all URIs and group folders which start with the group default folder path.
Parameters
| Name | Description | Required | Type | Default |
|---|---|---|---|---|
| name | The new name of the group | yes | string | |
| index | Whether to re-index the group after renaming | no | boolean | true |
Permission
This service requires administrator.
Response
This service returns the following XML:
<group-renaming> <thread ...> ... </thread> </group-renaming>
Error Handling
| Code | Cause / Description |
|---|---|
| 0x1101 | Illegal character in group name |
| 0x1103 | Group name in use |
| 0x1102 | Documents folder already exists |
| 0x1106 | Parent project missing or is a group |
| 0x1110 | Template folder already exists |
| 0x110F | Cannot change a group to a project or a project to a group |