Actuate Information Delivery API operations : GetDynamicData
 
GetDynamicData
Retrieves dynamic data from a report.
Request schema
<xsd:complexType name="GetDynamicData">
<xsd:sequence>
<xsd:element name="Object" type="typens:ObjectIdentifier"/>
<xsd:element name="ViewParameter"
type="typens:ViewParameter" minOccurs="0"/>
<xsd:element name="Component" type="typens:ComponentType"/>
<xsd:element name="DownloadEmbedded" type="xsd:boolean"
default="false" minOccurs="0"/>
<xsd:element name="CoordinateX" type="xsd:long"
minOccurs="0"/>
<xsd:element name="CoordinateY" type="xsd:long"
minOccurs="0"/>
</xsd:sequence>
</xsd:complexType>
Request elements
Object
The ID of the object from which to retrieve the dynamic data.
ViewParameter
The viewing parameters.
Component
The name, display name, or ID, and the value of the component for which to retrieve the dynamic data.
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.
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.
Response schema
<xsd:complexType name="GetDynamicDataResponse">
<xsd:sequence>
<xsd:element name="DynamicDataRef" 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
DynamicDataRef
The details of the attachment such as contentId, contentType, contentLength, contentEncoding, locale, and contentData.
ConnectionHandle
The ID of the report. Supports viewing a report when the report is already in iHub System. Specified in the SOAP header.
DataLinkingURL
If Format is ImageMapURL, the URL of the hyperlink. If no hyperlink is associated with the URL, an empty string is returned. If DataLinkingURL is used, an attachment is not returned.