Skip to main content

 Web service API

How to use PageSeeder's Web service API

unarchive project

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

com.pageseeder.group.UnarchiveGroup

Description

Unarchives a project.

This service starts an Asynchronous process.

The process does the following:

  1. Rename the project and remove the archive flag
  2. Modify the default project URI
  3. Move the template files back to the original location
  4. Optionally unarchive all groups under this project
  5. Optionally re-index all the groups as the index is cleared when a group is archived (requires allgroups=true)

Parameters

NameDescriptionRequiredTypeDefault value
allgroupsWhether to unarchive all the groups under this project.nobooleanfalse
indexWhether to re-index all the groups after unarchiving (requires allgroups=true)nobooleantrue

Permission

This service requires manager or higher.

Response

<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>
</group-unarchive>

Error Handling

No specific errors expected for this service.

Created on , last edited on