SelectPage
Retrieves a page or a set of pages. You can specify either a page number, a page range, a component, or other search criteria. Specify FileType in the SOAP header for all execute, submit, and view IDAPI requests.
The response to SelectPage contains the following data:
The SOAP response.
The attachment containing the data.
If the request input format is Reportlet, an XML response as an attachment. This response contains the post process data.
Request elements
Object
ObjectIdentifier. The object from which to retrieve the page. Specify either the object ID or the object name and version number.
ViewParameter
Choose from the following list of viewing parameters:
Page
PageIdentifier. The page or range of pages to retrieve.
Component
ComponentType. The name, display name, or ID, and the value of the component from which to retrieve the page. The following formats do not support specifying the component ID:
ExcelData
ExcelDisplay
PDF
RTF
SearchCriteria
String. The search criteria.
MaxHeight
Long. The maximum height, in points, according to the web page layout design. Required for a Reportlet.
CustomInputPara
String. The input parameters to send.
DownloadEmbedded
Boolean. Specifies whether to send the attachment embedded in the body of the SOAP message or in a separate MIME boundary. If True, the response contains the attachment as embedded data. If False, the attachment is in a separate MIME boundary. The default value is False.
SplitOversizePages
Boolean. Specifies whether to split a page to print to an output format that is smaller than the page. If True, the page is split. The default value is True.
PageWidth
Int. The page width page to use for printing the page.
PageHeight
Int. The page height page to use for printing the page.
Response elements
PageRef
Attachment. Contains the following properties of the attachment:
MimeType
ContentEncoding
ContentLength
Locale
PostResponseRef
Attachment. Contains the Reportlet parameters. Used PostResponseRef only when the request input format is Reportlet.
ConnectionHandle
String. The ID of the report. Supports viewing a report when the report is already in iHub System. Specified in the SOAP header.