Getting a Document as a ZIP file

Returns a ZIP file that archives reports of a Web Intelligence document.

Request

GET <webiURL>/documents/{documentId}/zips/{zipId}?fileName={fileName}

Where:

  • {documentId} is the document identifier retrieved from the list of documents
  • {zipId} is the ZIP file identifier
  • {fileName} is a string that defines the name of the ZIP file. Maximum string length is 96.

    This is an optional parameter. If set, the HTML output is zipped in a fileName.zip file and sent as attachment.

Response

Response type: application/zip

Response: the document as a ZIP file.

Example

GET <webiURL>/documents/14746/zips/0?fileName=myZipFile