Skip to main content

 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.

This service starts an Asynchronous process.

The process does the following

  1. Rename the group and remove the archive flag
  2. Modify the default group URI
  3. Move the default group folder URIs back to the original
  4. Optionally re-index the group as the index is cleared when a group is archived

Parameters

NameDescriptionRequiredTypeDefault value
indexWhether to re-index the group after unarchivingnobooleantrue

Permission

This service requires manager or higher.

Response

This service returns the following XML:

<group-unarchive>
  <thread id="[thread id]"
          name="[thread name]"
          username="[username of user starting thread]"
          groupid="[ID of group if applicable or -1]"
          status="[initialised|
                   inprogress|
                   error|
                   warning|
                   cancelled|
                   failed|
                   complete]">
    [<message>[explanation or error]<message>]
    [thread specific XML]
  </thread>
  </thread>
</group-unarchive>

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