GetContent
Retrieves the contents of the specified report component. Specify FileType in the SOAP header for all execute, submit, and view IDAPI requests.
The response to GetContent 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 is retrieved. The response contains the post process data.
Request schema
<xsd:complexType name="GetContent">
<xsd:sequence>
<xsd:element name="Object" type="typens:ObjectIdentifier"/>
<xsd:element name="ViewParameter"
type="typens:ViewParameter"/>
<xsd:element name="Component" type="typens:Component"/>
<xsd:element name="MaxHeight" type="xsd:long"
minOccurs="0"/>
<xsd:element name="CustomInputPara" type="xsd:string"
minOccurs="0"/>
<xsd:element name="DownloadEmbedded" type="xsd:boolean"
default="false" minOccurs="0"/>
</xsd:sequence>
</xsd:complexType>
Request elements
Object
The ID of the object from which to retrieve the contents. Specify either the object ID or the object name and version number.
ViewParameter
The viewing parameters.
Component
The component from which to retrieve the contents. Specify either name, display name, or ID, and the value of the component. The following formats do not support specifying the component ID:
ExcelData
ExcelDisplay
PDF
RTF
To retrieve the entire report, specify 0.
MaxHeight
Required for a Reportlet. The maximum height, in points, based on the web page layout design. By default, MaxHeight is 0, which means there is no limit to the height of the Reportlet. In this case, the entire component is converted into a Reportlet.
CustomInputPara
The input parameters to send.
DownloadEmbedded
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.
Response schema
<xsd:complexType name="GetContentResponse">
<xsd:sequence>
<xsd:element name="ContentRef" type="typens:Attachment"/>
<xsd:element name="PostResponseRef" type="typens:Attachment"
minOccurs="0"/>
<xsd:element name="ComponentId" type="xsd:string"/>
<xsd:element name="FileExtension" type="xsd:string"
minOccurs="0"/>
<xsd:element name="FileDescription" type="xsd:string"
minOccurs="0"/>
<xsd:element name="ConnectionHandle" type="xsd:string"
minOccurs="0"/>
</xsd:sequence>
</xsd:complexType>
Response elements
ContentRef
Contains the following properties of the attachment:
MimeType
ContentEncoding
ContentLength
Locale
PostResponseRef
Used only when the request input format is Reportlet. Contains the Reportlet parameters.
ComponentId
The component ID.
FileExtension
The file extension.
FileDescription
The description of the file.
ConnectionHandle
The ID of the report. Supports viewing a report when the report is already in iHub System. Specified in the SOAP header.