archive uri
/members/{member}/groups/{group}/uris/{uri}/archive [POST]
| API Support | Available since | Last updated | Output |
|---|---|---|---|
| 4.9500 | 6.0000 | xml, json |
Description
Archive a document or a folder.
If the URI is a folder this service starts an Asynchronous process.
This service can be used to archive a URI (that is either a document or a folder) by moving it to the Archive folder for the specified group.
Documents
If the URI corresponds to a Document, the URI is moved to the archive folder. If there is a corresponding file in the underlying file system, it is also moved.
Folders
If the URI corresponds to a Folder, its contents are moved in a separate thread provided there are no sub-folders. It also moves any underlying physical file if applicable.
Parameters
| Name | Description | Required | Type | Default |
|---|---|---|---|---|
| removexrefs | Whether to remove image references and outgoing xrefs from the archived documents | no | boolean | false |
Permission
This service requires contributor or higher.
Response
This service returns the following XML:
<uri-archive> [<thread ...> ... </thread>|<uri ...> ... </uri>] </uri-archive>
Error Handling
| Code | Cause / Description |
|---|---|
| 0x1202 | The ‘archive’ folder for a group cannot be removed |
| 0x1203 | The URI is already archived |
| 0x1204 | There is no default Group URI |