Exporting a Document as Pages

Exports in paginated mode to various formats a Web Intelligence document referenced by its ID.

Request

GET <webiURL>/documents/{documentId}/pages?[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
mode

normal or quickDisplay.

All
orientation

Page orientation. Use to force a specific page orientation. Values are portrait and landscape.

If mode=normal
widthScaling

Number of pages per report displaying in width. Default is 0 and means no constraint in width.

If mode=normal
heightScaling

Number of pages per report displaying in height. Default is 0 means no constraint in height.

If mode=normal
unit

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

XML
optimized

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

MS Excel 2003 and MS Excel 2007
Response

Response type:

  • text/xml
  • application/pdf
  • application/vnd.ms-excel for MS Excel 2003
  • application/vnd.openxmlformats-officedocument.spreadsheetml.sheet for MS Excel 2007

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

Example

XML

Exports the XML result in xmlfile.xml.

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

Example

PDF

Exports the PDF result in exportpdffile.pdf.

curl -G -s -H "accept:application/pdf" -H X-SAP-LogonToken:"""%tokenValue%"""
 <webiURL>/documents/8022/pages?mode=quickDisplay" > exportpdffile.pdf

Example

MS Excel 2003

Exports the result in excel2003.xls file.

curl -G -s -H "accept:application/vnd.ms-excel" -H X-SAP-LogonToken:"""%tokenValue%"""
 <webiURL>/documents/8022/pages?mode=normal" > excel2003.xls

Example

MS Excel 2007

Exports the result in excel2007.xlsx file.

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