Retrieving report parameter values
Use GetReportParameters to retrieve the parameter values of a specific report object value (.rov) file. Use one of the following identifiers to specify which ROV to use:
JobId. BIRT iHub finds the associated ROV and reads the parameters from that file.
The name or identifier of the file for which you want to retrieve parameter values. This file can be a BIRT or external report executable file, a parameter values file, or a third-party compound storage file.
For a date parameter, BIRT iHub returns parameter values in the General Date format, regardless of the DateTime settings in localemap.xml. For example, the General Date format is mm/dd/yyyy hh:mm:ss for the US English locale.
The following example requests parameters for a job:
<SOAP-ENV:Body>
<GetReportParameters>
<JobId>16</JobId>
</GetReportParameters>
</SOAP-ENV:Body>
The response includes all parameters stored in the ROV:
<SOAP-ENV:Body>
<GetReportParametersResponse>
<ParameterList>
<ParameterDefinition>
<Group>Customer Parameters</Group>
<Name>customers_creditrank</Name>
<DefaultValue></DefaultValue>
<IsRequired>false</IsRequired>
<IsPassword>false</IsPassword>
<IsHidden>false</IsHidden>
<DisplayName>Credit Rank</DisplayName>
<IsAdHoc>false</IsAdHoc>
</ParameterDefinition>
<ParameterDefinition>
<Group>Customer Parameters</Group>
<Name>customers_customName</Name>
<DataType>String</DataType>
<DefaultValue></DefaultValue>
<IsRequired>false</IsRequired>
<IsPassword>false</IsPassword>
<IsHidden>false</IsHidden>
<DisplayName>Customer Name</DisplayName> <IsAdHoc>true</IsAdHoc>
<ColumnName>Name</ColumnName>
<ColumnType>String</ColumnType>
</ParameterDefinition>
…
</ParameterList>
</GetReportParametersResponse>
</SOAP-ENV:Body>
If IsAdHoc is True for any parameter, the response returns ColumnName and ColumnType in the ParameterDefinition element of that parameter.