unarchive group
/members/{member}/groups/{group}/unarchive [POST]
| API Support | Available since | Last updated | Output |
|---|---|---|---|
| 4.9500 | 5.9809 | xml, json |
Description
Unarchive a group.
This service starts an Asynchronous process.
The process does the following
- Rename the group and remove the archive flag
- Modify the default group URI
- Move the default group folder URIs back to the original
- Optionally re-index the group as the index is cleared when a group is archived
Parameters
| Name | Description | Required | Type | Default |
|---|---|---|---|---|
| index | Whether to re-index the group after unarchiving | no | boolean | true |
Permission
This service requires manager or higher.
Response
This service returns the following XML:
<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> </thread> </group-unarchive>
Error Handling
No specific errors expected for this service.
See logs for more details about the effect of this service.