rename project
/members/{member}/projects/{group}/rename [POST]
| API Support | Available since | Last updated | Output |
|---|---|---|---|
| 5.5004 | 6.0000 | xml |
Description
Launch a rename thread for the project.
Invoking this service starts an Asynchronous process.
The thread does the following
- Update the project name, project template and visibility (control group) if not
public. - Rename the project default folder path in the file system.
- Update all URIs and group folders which start with the project default folder path.
- Update the name, project template and visibility (control group) if not
public, of all subprojects/groups. Also, rename the project’s folder under template and woconfig.
Parameters
| Name | Description | Required | Type | Default value |
|---|---|---|---|---|
| name | The new name of the group | yes | string | |
| index | Whether to re-index all the groups under this project 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 | Config folder already exists (for template or web folder) |
| 0x110F | Cannot change a group to a project or a project to a group |