GetEmbeddedComponent
Retrieves an embedded component from a report.
Request schema
<xsd:complexType name="GetEmbeddedComponent">
<xsd:sequence>
<xsd:element name="ObjectId" type="xsd:string"/>
<xsd:element name="Operation" type="xsd:string"/>
<xsd:element name="StreamName" type="xsd:string"
minOccurs="0"/>
<xsd:element name="Embed" type="xsd:int" minOccurs="0"/>
<xsd:element name="ComponentId" type="xsd:string"
minOccurs="0"/>
<xsd:element name="ScalingFactor" type="xsd:long"
minOccurs="0"/>
<xsd:element name="AcceptEncoding" type="xsd:string"
minOccurs="0"/>
<xsd:element name="DownloadEmbedded" type="xsd:boolean"
default="false" minOccurs="0"/>
<xsd:element name="Format" type="xsd:string" minOccurs="0"/>
<xsd:element name="CoordinateX" type="xsd:long"
minOccurs="0"/>
<xsd:element name="CoordinateY" type="xsd:long"\
minOccurs="0"/>
<xsd:element name="RedirectPath"type="xsd:string"
minOccurs="0"/>
</xsd:sequence>
</xsd:complexType>
Request elements
ObjectId
The ID of the object from which to retrieve the data.
Operation
The type of data to retrieve. Valid values are:
GetStaticData
Retrieves static data
GetDynamicData
Retrieves dynamic data
GetStyleSheet
Retrieves the style sheet
StreamName
The stream name. Required if the operation is GetStaticData, optional otherwise.
Embed
Required if the operation is GetStaticData, optional otherwise.
ComponentId
The ID of the component from which to retrieve the data. Required if the operation is GetDynamicData, optional otherwise.
ScalingFactor
Supported only for GetDynamicData and GetStaticData operations. Adapts the size of a Reportlet to the Reportlet frame.
AcceptEncoding
The list of encoding methods the browser supports.
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.
Format
Applies only if the operation is GetDynamicData. The format in which the report displays. To support users clicking a point in a chart to navigate to different report sections, set Format to ImageMapURL and set the CoordinateX and CoordinateY elements.
CoordinateX
The x-axis coordinate of the chart element the user chose. Required if Format is ImageMapURL.
CoordinateY
The y-axis coordinate of the chart element the user chose. Required if Format is ImageMapURL.
RedirectPath
The context path to the hyperlink.
Response schema
<xsd:complexType name="GetEmbeddedComponentResponse">
<xsd:sequence>
<xsd:element name="EmbeddedRef" type="typens:Attachment"/> <xsd:element name="EmbeddedRef" type="typens:Attachment"/>
<xsd:element name="ConnectionHandle" type="xsd:string"
minOccurs="0"/>
<xsd:element name="DataLinkingURL" type="xsd:string"
minOccurs="0"/>
</xsd:sequence>
</xsd:complexType>
Response elements
EmbeddedRef
Contains the following properties of the attachment:
MimeType
ContentEncoding
ContentLength
Locale
ConnectionHandle
The ID of the report. Supports viewing a report when the report is already in iHub System. Specified in the SOAP header.
DataLinkingURL
The URL of the hyperlink if Format is set to ImageMapURL. If no hyperlink is associated with the URL, an empty string is returned. If DataLinkingURL is used, no attachment is returned.