Exporting a Document in Listing Mode

Exports the whole Web Intelligence document to the desired format:

  • XML
  • zipped HTML
  • PDF
  • Microsoft Excel 2003
  • Microsoft Excel 2007
Note 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}?[parameters]

Where:
  • {documentId} is the document identifier retrieved from the list of documents
Table 1: Optional Parameters
Parameter Description Supported Formats
dpi

Resolution in dots per inch (dpi) for generated charts. Value between 75 and 9600. Default is 300 for PDF format, 96 for all other formats.

All
unit

A string that defines the unit that sizes will be reported in. Values are "metric", "millimeter", "point", and "pixel" (default).

XML
rawValues Boolean. Default is false. If true, the raw values and their types are exported with the formatted values. XML
fileName

A string that defines the name of the ZIP file. If set, the HTML output is zipped to a fileName.zip file. Maximum string length is 96.

ZIP
optimized

Boolean. Default is false. If true, the generated output is optimized for calculations inside Microsoft Excel.

Microsoft Excel 2003 and Microsoft Excel 2007

Response

Response type:

  • text/xml
  • application/zip for zipped HTML
  • application/pdf
  • application/vnd.ms-excel for Microsoft Excel 2003
  • application/vnd.openxmlformats-officedocument.spreadsheetml.sheet for Microsoft Excel 2007

The response is the file whose name is the document identifier with the output extension type.

Example

XML

Exports the XML result in the xmlfile.xml, with a resolution of 150 dpi for any generated charts.

curl -G -s -H "accept:text/xml" -H X-SAP-LogonToken:"""%tokenValue%"""
 "<webiURL>/documents/8022?dpi=150&size=pixel" > xmlfile.xml

Example

PDF

Exports the result with the file name exportpdf.pdf. The default resolution of 300 dpi for any generated charts is used.

curl -G -s -H "accept:application/pdf" -H X-SAP-LogonToken:"""%tokenValue%"""
 <webiURL>/documents/8022" > exportpdf.pdf

Example

Microsoft Excel 2003

Exports the result with the file name excel2003.xls file. The output is optimized for calculations inside Microsoft Excel, and any generated charts will have a resolution of 150 dpi.

curl -G -s -H "accept:application/vnd.ms-excel" -H X-SAP-LogonToken:"""%tokenValue%"""
 <webiURL>/documents/8022?optimized=true&dpi=150" > excel2003.xls

Example

Microsoft Excel 2007

Exports the result in the excel2007.xls file. The output is optimized for calculations inside Microsoft Excel.

curl -G -s -H "accept:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet"
 -H X-SAP-LogonToken:"""%tokenValue%""" <webiURL>/documents/8022?optimized=true" > excel2007.xls