Exporting a Document as a Series of Pages

Usage

Exports a Web Intelligence document as a series of pages in one of the following formats:

  • XML
  • PDF
  • Microsoft Excel 2003
  • Microsoft Excel 2007
Request

GET /documents/<documentID>/pages?<optional_parameters>

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. The document setting applies by default.

If mode=normal
heightScaling

Number of pages per report displaying in height. The document setting applies by default.

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
rawValues Boolean. Default is false. If true, the raw values and their types are exported with the formatted values. XML
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/pdf
  • application/vnd.ms-excel for Microsoft Excel 2003
  • application/vnd.openxmlformats-officedocument.spreadsheetml.sheet for Microsoft 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%"""
 <base_webi_REST_URL>/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%"""
 <base_webi_REST_URL>/documents/8022/pages?mode=quickDisplay" > exportpdffile.pdf

Example

Microsoft Excel 2003

Exports the result in excel2003.xls file.

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

Example

Microsoft 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%""" <base_webi_REST_URL>/documents/8022/pages?optimized=true" > excel2007.xlsx