unzip loading zone content
/members/{member}/groups/{group}/loadingzone/unzip [POST]
API Support | Available since | Last updated | Output |
---|---|---|---|
4.9000 | 5.2102 | xml |
Description
Unzip content in a member loading zone.
This service unzips the content of a ZIP (that has already been uploaded into the loading zone) into the same loading zone.
Uploading ZIP files simplifies the upload process and allows users to preserve the folder structure when uploading a collection of files.
Invoking this service starts an Asynchronous process.
Parameters
Name | Description | Required | Type | Default |
---|---|---|---|---|
path | The path to the resource to unzip, typically a ZIP file (relative to the root of the loading zone) | yes | path | |
deleteoriginal | A flag to indicate whether the original ZIP is deleted from the loading zone after a successful unzip | no | boolean | false |
uploadid | The upload ID if applicable | no | string | |
xlinkid | A comment ID used to build an upload ID (for comment attachments’ loading zone) | no | long |
Permission
This service requires contributor or higher.
Response
This service returns the following XML:
<load-unzip> <thread ...> ... </thread> </load-unzip>
Error Handling
No specific errors expected for this service.
The error handling in the service is non-standard and has been scheduled to be revised.