Getting a Document as a ZIP file

Returns a ZIP file that archives the document reports of your choice as HTML files.
Note
  • You create the ZIP file by calling POST <webiURL>/documents/{documentId}/zips?reportIds={reportId[,...]}.
  • You can export a document with all of its reports as a ZIP file by calling GET <webiURL>/documents/{documentId}?fileName={fileName}.
  • Exports to HTML will be optimized for your browser if you use the User-Agent HTTP header in the REST API call.
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 retrieved from the POST call.
  • {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