Web service API

How to use PageSeeder's Web service API

unzip loading zone content

/members/{member}/groups/{group}/loadingzone/unzip [POST]

com.pageseeder.load.generators.LoadingZoneUnzip

Description

Unzip content in a member loading zone.

This service unzips the content of a ZIP (that has already been uploaded in the loading into the loading zone) into the same loading zone.

Uploading ZIP files simplifies the upload process and allows users to preserve the directory structure when uploading a collection of files.

Invoking this service will start an Asynchronous process.

Parameters

NameDescriptionRequiredTypeDefault value
pathThe path to the resource to unzip, typically a ZIP file (relative to the root of the loading zone)yespath
deleteoriginalA flag to indicate whether the original ZIP should be deleted from the loading zone after a successful unzipnobooleanfalse
uploadidThe upload ID if applicablenostring
xlinkidA comment ID used to build an upload ID (for comment attachments' loading zone).nolong

Permission

Undocumented permissions requirements.

Response

This service returns the following XML:

<load-unzip>
  <thread ...>
    ...
  </thread>
</load-unzip>

Error Handling

No specific errors expected for this service.

Warning!

The error handling in the service is non-standard and has been scheduled to be revised.

Created on , last edited on