GetTOC
Returns the report’s table of contents in XMLDisplay format.
Request schema
<xsd:complexType name="GetTOC">
<xsd:sequence>
<xsd:element name="Object" type="typens:ObjectIdentifier"/>
<xsd:element name="ViewParameter"
type="typens:ViewParameter"/>
<xsd:element name="TocNodeId" type="xsd:string"/>
<xsd:element name="Depth" type="xsd:string"/>
<xsd:element name="DownloadEmbedded" type="xsd:boolean"
default="false"
</xsd:sequence>
</xsd:complexType>
Request elements
Object
The ID of the object from which to retrieve the table of contents.
ViewParameter
The viewing parameters. To support users clicking a point in a chart to navigate to different report sections, set the ViewParameter Format to ImageMapURL.
TocNodeId
The ID of the table of contents node.
Depth
The depth of the table of contents.
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="GetTOCResponse">
<xsd:sequence>
<xsd:element name="TocRef" type="typens:Attachment"/>
<xsd:element name="ConnectionHandle" type="xsd:string"
minOccurs="0"/>
</xsd:sequence>
</xsd:complexType>
Response elements
TocRef
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.