Header
The SOAP header that contains authentication data, locale information, and other required or optional data.
Schema
<xsd:complexType name="Header">
<xsd:sequence>
<xsd:element name="AuthId" type="xsd:string" />
<xsd:element name="TargetVolume" type="xsd:string"
minOccurs="0" />
<xsd:element name="Locale" type="xsd:string" minOccurs="0" />
<xsd:element name="ConnectionHandle" type="xsd:string"
minOccurs="0" />
<xsd:element name="TargetServer" type="xsd:string"
minOccurs="0" />
<xsd:element name="DelayFlush" type="xsd:boolean"
minOccurs="0" />
<xsd:element name="FileType" type="xsd:string"
minOccurs="0"/>
<xsd:element name="TargetResourceGroup" type="xsd:string"
minOccurs="0"/>
<xsd:element name="RequestID" type="xsd:string"
minOccurs="0"/>
</xsd:sequence>
</xsd:complexType>
Elements
AuthId
A system-generated, encrypted string. All requests except Login requests must have a valid AuthId in the SOAP header. The header passes this ID to BIRT iHub for validation.
TargetVolume
The Encyclopedia volume to which to direct the request.
Locale
Locale is used to format data using the language, date and time conventions, currency and other locale-specific conventions.
ConnectionHandle
An optional element that supports keeping a connection open to view a persistent report.
TargetServer
An optional element that refers to the BIRT iHub within a cluster to which to direct the request.
DelayFlush
A Boolean element that tells BIRT iHub to write updates to the disk when the value is False.
FileType
An optional element that supports specifying the file type to run, such as a BIRT design or HTML file.
TargetResourceGroup
An optional element that supports assigning a synchronous report generation request to a specific resource group at run time.
RequestID
A unique value that identifies the SOAP message.