Web service API

How to use PageSeeder's Web service API

unarchive group

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

com.pageseeder.group.UnarchiveGroup

Description

Unarchive a group.

Because groups can contain many items to process, this service is asynchronous. It simply launches an unarchive group thread. The entire unarchival process may last up to a few minutes.

The thread will do the following

  1. Rename the group and remove the archive flag
  2. Create any missing parent project
  3. Modify the default group URI
  4. Move the default group folder URIs back to the original

The progress of the thread can be monitored in the process logs.

Parameters

No parameters required.

Permission

Requires a role which allows the archiving of groups.

Response

This service returns the following XML:

<thread>
  <id>[thread id]</id>
  <name>[thread name]</name>
  <username>[username of user starting thread]</username>
  <progress current="[number out of total]"
            total="[total number of actions]"/>
  <threadstatus>
    <status>[INITIALISED|INPROGRESS|ERROR|WARNING|CANCELLED|FAILED|COMPLETE]</status>
    <message>[explanation or error - may include XML]</message>
  </threadstatus>
</thread>

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