Archive (ZIP) - Extract

Overview

The 'Archive (ZIP) - Extract' flow action enables files contained within supported archive package formats to be extracted.

Input Archive Formats

The following archive file formats are supported.

• BZIP2
• CAB
• CPIO
• GZIP
• LZIP
• LZMA
• RAR
• 7Z
• SNAPPY
• TAR
• WIM
• XAR
• XZ
• Z
• ZIP

Credit Count

This action consumes 1 credit per operation.

Note, different Encodian actions can consume different number credits. Please always check the action specific documentation and read What is an Encodian Action for a full description of how credits are consumed.

Default Parameters

The default 'Archive (ZIP) - Extract' flow action parameters are detailed below:

• File Content: The file content of the archive
• Password: Set a password for opening the archive

Advanced Parameters

The advanced 'Archive (ZIP) - Extract' flow action parameters are detailed below:

• Include Folders: Set whether to extract files contained within folders which are present in the archive

Return Parameters

The 'Archive (ZIP) - Extract' flow action returns the following data. 

Action Specific Return Values

• Documents - The collection of files extracted from the archive provided

Each document within the documents collection contains the following values:

• Documents Filename - The filename of the file
• Documents File Content - The file content of the file

Standard Return Values

• OperationId - The unique ID assigned to this operation.
• HttpStatusCode - The HTTP Status code for the response.
• HttpStatusMessage - The HTTP Status message for the response.
• Errors - An array of error messages should an error occur.
• Operation Status - Indicates whether the operation has been completed, has been queued or has failed.