Skip to main content

 Services

Web services from /about to /webhooks

archive uri

/members/{member}/groups/{group}/uris/{uri}/archive [POST]

com.pageseeder.uri.ArchiveURI

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

NameDescriptionRequiredTypeDefault
removexrefsWhether to remove image references and outgoing xrefs from the archived documentsnobooleanfalse

Permission

This service requires contributor or higher.

Response

This service returns the following XML:

<uri-archive>
  [<thread ...> ... </thread>|<uri ...> ... </uri>]
</uri-archive>

Error Handling

CodeCause / Description
0x1202The ‘archive’ folder for a group cannot be removed
0x1203The URI is already archived
0x1204There is no default Group URI
Created on , last edited on