GetReportParameters
Retrieves report parameter values. GetReportParameters requires execute or read privileges when executed against a BIRT design, BIRT data design, or BIRT 360 dashboard file. When executed against a BIRT document file, GetReportParameters requires execute, secure read, or read privileges.
Request schema
<xsd:complexType name="GetReportParameters">
<xsd:sequence>
<xsd:choice>
<xsd:element name="JobId" type="xsd:string"/>
<xsd:element name="ReportFileId" type="xsd:string"/>
<xsd:element name="ReportFileName" type="xsd:string"/>
</xsd:choice>
<xsd:element name="ReportParameterType"
type="typens:ReportParameterType" minOccurs="0"/>
<xsd:element name="WithoutDynamicPickList"
type="xsd:boolean" minOccurs="0"/>
</xsd:sequence>
</xsd:complexType>
Request elements
JobId
The ID of the job from which to retrieve the parameter values. Specify JobId to retrieve the parameter values from the report file associated with the job.
ReportFileId
The ID of the file from which to retrieve the parameter values. Specify ReportFileId or Report FileName to retrieve parameter values from an executable, document, or object value file, or a third-party compound storage file.
ReportFileName
The name of the file from which to retrieve the parameter values. Specify ReportFileName or Report FileId to retrieve parameter values from an executable, document, or object value file, or a third-party compound storage file.
ReportParameterType
Optional parameter type can include Execution, View, and All. If not specified, only execution parameters return to maintain backward compatibility.
WithoutDynamicPickList
If set to True, parameters will be returned without a dynamic pick list.
Response schema
<xsd:complexType name="GetReportParametersResponse">
<xsd:sequence>
<xsd:element name="ParameterList"
type="typens:ArrayOfParameterDefinition"/>
<xsd:element name="ViewParameterList"
type="typens:ArrayOfParameterDefinition" minOccurs="0"/>
</xsd:sequence>
</xsd:complexType>
Response elements
ParameterList
The list of parameter definition values such as group, cascading parent name, name, data type, default value, display name, help text, and so forth.
ViewParameterList
The list of view parameter definition values such as format, user agent, scaling factor, accept encoding, view operation, path information, embedded object path, redirect path, and PDF quality.