Actuate Information Delivery API operations : About the SOAP header
 
About the SOAP header
The SOAP header contains authentication data, locale information, and other required and optional data. The SOAP header element is mandatory for calls to the BIRT iHub. Table 8‑1 lists all SOAP header elements that the Actuate Information Delivery API uses.
Table 8‑1 SOAP header elements
Element
Description
AuthId
The system-generated, encrypted string that the system returns in the Login response when the client logs in using the Actuate Information Delivery API.
Required for all requests except Login requests.
ConnectionHandle
An optional element that supports keeping a connection open to view a persistent report. If ConnectionHandle is present in the SOAP header, the system routes subsequent viewing requests to the same View service that returned the ConnectionHandle.
If present, BIRT iHub System ignores the value of TargetVolume.
DelayFlush
A Boolean element that tells BIRT iHub to write updates to the disk when the value is False.
FileType
Specifies which type of file the request contains. Specify FileType in the SOAP header for all execute, submit, and view IDAPI requests.
Locale
An optional element that specifies the locale to use for formatting locale-specific information, such as language, date and time, and other locale-specific conventions before returning the data to the client.
If the client does not specify another locale, BIRT iHub System uses the client’s default locale.
ReportType
An optional element that specifies which type of report to run.
RequestID
A unique value that identifies the SOAP message.
TargetResourceGroup
An optional element that assigns a synchronous report generation request to a specific resource group at run time.
TargetServer
An optional element that refers to the BIRT iHub in a cluster to which to direct the request. Use this element for requests pertaining to system administration tasks, such as GetFactoryServiceJobs and GetFactoryServiceInfo.
TargetVolume
An element that specifies the Encyclopedia volume to which to direct the request. In Release 10, TargetVolume is an optional element. In Release 11 and iHub, Login and other subsequent messages must specify the Encyclopedia volume name using TargetVolume in the SOAP header.