archive project
/members/{member}/projects/{group}/archive [POST]
| API Support | Available since | Last updated | Output |
|---|---|---|---|
Description
Launch an archive thread for the project.
Invoking this service starts an Asynchronous process.
The thread does the following
- Prefix the project name with 'archive-' and add the archive flag
- Prefix the name of all descendant projects/groups with 'archive-' and add the archive flag
- Create any missing archive parent project
- Modify the default project folder and all the URIs below.
- Clears the group indexes.
Parameters
| Name | Description | Required | Type | Default |
|---|---|---|---|---|
| note | Reason for archiving (appended to project/group descriptions) | no | string |
Permission
This service requires manager or higher.
Response
This service returns the following XML:
<group-archive>
<thread ...>
...
</thread>
</group-archive>
Error Handling
| Code | Cause / Description |
|---|---|
| 0x1111 | The group is already archived |