|API Support||Available since||Last updated||Output|
Archive a document or a folder.
If the URI is a folder this service starts an Asynchronous process.
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.
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.
|removexrefs||Whether to remove image references and outgoing xrefs from the archived documents||no||boolean|
This service requires contributor or higher.
This service returns the following XML:
<uri-archive> [<thread ...> ... </thread>|<uri ...> ... </uri>] </uri-archive>
|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|