Web service API

How to use PageSeeder's Web service API

archive group

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

com.pageseeder.group.ArchiveGroup

Description

Archive the group

Invoking this service will start an Asynchronous process.

The thread will do the following

  1. Prefix the group name with 'archive-' and add the archive flag
  2. Create any missing archive parent project
  3. Modify the default group URI and all the URIs below

Parameters

No parameters required - the group is already specified in the path component of the URL.

Permission

Requires a role which allows the archiving of groups.

Response

This service returns the following XML:

<group-archive>
  <thread ...>
    ...
  </thread>
</group-archive>

Error handling

No specific errors expected for this service.

See logs for more details about the effect of this service.

Created on , last edited on