Web service API

How to use PageSeeder's Web service API

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 will start 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 will simply be moved to the archive folder. If there is a corresponding file in the underlying file system, it will also be moved.

Folders

If the URI corresponds to a folder, its contents will be moved in a separate thread provided there are no sub-folders. It will also move any underlying physical file if applicable.

Parameters

No parameters required.

Permission

Permissions requirements to be updated.

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