ExecuteQuery
Reads a query and generates a DOI.
Request schema
<xsd:complexType name="ExecuteQuery"> xsd:sequence>
<xsd:element name="JobName" type="xsd:string"/>
<xsd:choice>
<xsd:element name="InputFileName" type="xsd:string"/>
<xsd:element name="InputFileId" type="xsd:string"/>
</xsd:choice>
<xsd:element name="SaveOutputFile" type="xsd:boolean"
minOccurs="0"/>
<xsd:element name="RequestedOutputFile" type="typens:NewFile"
minOccurs="0"/>
<xsd:choice minOccurs="0">
<xsd:element name="QueryFileName" type="xsd:string"/>
<xsd:element name="QueryFileId" type="xsd:string"/>
<xsd:element name="Query" type="typens:Query"/>
</xsd:choice>
<xsd:element name="ProgressiveViewing" type="xsd:boolean"
minOccurs="0"/>
<xsd:element name="RunLatestVersion" type="xsd:boolean"
minOccurs="0"/>
<xsd:element name="IsBundled" type="xsd:boolean"
minOccurs="0"/>
<xsd:element name="WaitTime" type="xsd:int" minOccurs="0"/>
</xsd:sequence>
</xsd:complexType>
Request elements
JobName
The job name.
InputFileName
The name of the file to use for the query.
InputFileId
The ID of the file to use for the query.
SaveOutputFile
Specifies whether the output file is transient or persistent. If True, the output file is transient. If False, the output file is persistent.
RequestedOutputFile
The output file attributes.
QueryFileName
The name of the output file.
QueryFileId
The ID of the output file.
Query
The query the user selected.
ProgressiveViewing
Specifies whether progressive viewing is enabled.
RunLatestVersion
Used only if the input file is a data object values (.dov) file. Specifies whether the DOV is merged with the latest version of the Actuate Basic information object executable (.dox) file. If True, the DOV is merged. If False, the DOV is not merged.
IsBundled
Specifies whether the report is bundled. If True, the report is bundled. If False, the report is not bundled. The default value is False.
WaitTime
The number of seconds BIRT iHub waits before sending a response to the report generation request. Use WaitTime to provide the ability to cancel a synchronous report generation request. The default value is 150 seconds.
Response schema
<xsd:complexType name="ExecuteQueryResponse">
<xsd:sequence>
<xsd:element name="Status"
type="typens:ExecuteReportStatus">
<xsd:element name="ErrorDescription" type="xsd:string"
minOccurs="0"/>
<xsd:element name="OutputFileType" type="xsd:string"
minOccurs="0"/>
<xsd:element name="ObjectId" type="xsd:string"/>
<xsd:element name="ConnectionHandle" type="xsd:string"
minOccurs="0"/>
<xsd:element name="ExecutableFileId" type="xsd:string"
minOccurs="0"/>
</xsd:sequence>
</xsd:complexType>
Response elements
Status
The status of the request. One of the following values:
Done
Failed
FirstPage
ErrorDescription
The description of the error. Returned if Status is Failed.
OutputFileType
The type of the report.
ObjectId
The object ID of the report.
ConnectionHandle
The ID of the report. Supports viewing a report when the report is already in iHub System. Specified in the SOAP header.
ExecutableFileId
The file ID of the executable returned from the query.