SearchReport
Searches a report for the specified criteria.
Request schema
<xsd:complexType name="SearchReport">
<xsd:sequence>
<xsd:element name="Object" type="typens:ObjectIdentifier"/>
<xsd:element name="ViewParameter"
type="typens:ViewParameter"/>
<xsd:choice minOccurs="0">
<xsd:element name="SearchReportByNameList"
type="typens:SearchReportByNameList"/>
<xsd:element name="SearchReportByIdList"
type="typens:SearchReportByIdList"/>
<xsd:element name="SearchReportByIdNameList"
type="typens:SearchReportByIdNameList"/>
</xsd:choice>
<xsd:element name="Range" type="typens:Range"
minOccurs="0"/>
<xsd:element name="DownloadEmbedded" type="xsd:boolean"
default="false" minOccurs="0"/>
<xsd:element name="OutputProperties"
type="typens:SearchResultProperties" minOccurs="0"/>
</xsd:sequence>
</xsd:complexType>
Request elements
Object
The ID of the object to search.
ViewParameter
The viewing parameters. SearchReport uses a different set of formats than other operations that use the ViewParameter data type. Valid formats are:
CSV
EXCEL
TSV
UNCSV
UNTSV
XMLDisplay
Optionally, you can specify the UserAgent. UserAgent specifies which browser to use for report viewing.
Range
The range containing the first and last record number. The range starts at 0.
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.
OutputProperties
Applies only if Format is CSV. The properties to include in the search result are:
EnableColumnHeaders
If True, column headers are included in the search result. The default value is True.
UseQuoteDelimiter
If True, each data item in the search result is enclosed in double quotes (" "). The default value is True.
Response schema
<xsd:complexType name="SearchReportResponse">
<xsd:sequence>
<xsd:element name="SearchRef" type="typens:Attachment"/>
<xsd:element name="ConnectionHandle" type="xsd:string"
minOccurs="0"/>
<xsd:element name="ReportType" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:enumeration value="ActuateBasic"/>
<xsd:enumeration value="ActuateBasicInfoObj"/>
<xsd:enumeration value="InfomationObject"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
Response elements
SearchRef
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.
ReportType
The report type. Valid report types are:
ActuateBasic
ActuateBasicInfoObj
InformationObject