Add to Archive (ZIP)

Overview

The 'Add to Archive (ZIP)' flow compresses and adds up to 1000 files to a zip package (.zip). 

Example Flow

Please refer to the following article detailing how to 'Retrieve a collection of files and add to an Archive package (ZIP File)'

Default Parameters

The default 'Add to Archive (ZIP)' flow action parameters are detailed below:

  • Filename: The filename to assign to the resulting zip file (including the zip file extension).
  • Documents: An array of documents to add to the zip package

As a manually entered array:

  • Filename: The filename of the source document (including the file extension).
  • File Content: A Base64 encoded representation of the document

mceclip2.png

As an array object:

mceclip1.png

Documents - JSON Schema 

The JSON provided within the documents parameter should conform to the following schema:

{
"fileName": "<Filename including extension>",
"fileContent": "<File contents (Base 64 string)>"
}

 Advanced Parameters

The advanced 'Add to Archive (ZIP)' flow action parameters are detailed below:

  • Encoding: Set the encoding type used for archiving documents.

mceclip4.png

Return Parameters

The 'Add to Archive (ZIP)' flow action returns the following data. 

Standard Return Values

  • Filename - An filename provided.
  • FileContent - A base64 string representation of the archive (.zip) file.
  • 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 completed, has been queued or has failed.

 

Have more questions? Submit a request

0 Comments

Please sign in to leave a comment.
Powered by Zendesk