unarchive project
/members/{member}/projects/{group}/unarchive [POST]
API Support | Available since | Last updated | Output |
---|---|---|---|
4.9500 | 5.9809 | xml, json |
Description
Unarchives a project.
This service starts an Asynchronous process.
The process does the following:
- Rename the project and remove the archive flag
- Modify the default project URI
- Move the template files back to the original location
- Optionally unarchive all groups under this project
- Optionally re-index all the groups as the index is cleared when a group is archived (requires
allgroups=true
)
Parameters
Name | Description | Required | Type | Default |
---|---|---|---|---|
allgroups | Whether to unarchive all the groups under this project. | no | boolean | false |
index | Whether to re-index all the groups after unarchiving (requires allgroups=true ) | no | boolean | true |
Permission
This service requires manager or higher.
Response
<group-unarchive> <thread id="[thread id]" name="[thread name]" username="[username of user starting thread]" groupid="[ID of group if applicable or -1]" status="[initialised| inprogress| error| warning| cancelled| failed| complete]"> [<message>[explanation or error]<message>] [thread specific XML] </thread> </group-unarchive>
Error Handling
No specific errors expected for this service.