ReportingService2006.GetReportParameters Method (String, String, ParameterValue[], DataSourceCredentials[])


Returns report parameter properties for a specified report. The M:ReportService2006.ReportingService2006.GetReportParameters(System.String,System.String,System.Boolean,ReportService2006.ParameterValue[],ReportService2006.DataSourceCredentials[]) method can also be used to validate parameter values against parameters for a specified report.

Namespace:   ReportService2006
Assembly:  ReportService2006 (in ReportService2006.dll)

public ReportParameter[] GetReportParameters(
	string Report,
	string HistoryID,
	ParameterValue[] Values,
	DataSourceCredentials[] Credentials


Type: System.String

The fully qualified URL of the report including the file name and .rdl file name extension.

Type: System.String

The ID of the report history snapshot. Set the ForRendering parameter to a value of true in order to retrieve parameter properties for a report history snapshot. Set the value to null (Nothing in Visual Basic) if you are retrieving parameters for a report that is not a report history snapshot.

Type: ReportService2006.ParameterValue[]

The parameter values (ParameterValue objects) that can be validated against the parameters of a report.

Type: ReportService2006.DataSourceCredentials[]

The data source credentials (DataSourceCredentials objects) that can be used to validate query parameters.

Return Value

Type: ReportService2006.ReportParameter[]

An array of ReportParameter objects that lists the parameters for the report.

The table below shows header and permissions information on this operation.

SOAP Headers

(In) TrustedUserHeaderValue

(Out) ServerInfoHeaderValue

Required Permissions


If the execution setting for the report is Snapshot, the parameter metadata that is returned is the data that was used when the report history snapshot was created. If the execution setting for the report is Live, the parameter metadata returned represents the parameter data that is associated with the specified report.

If you provide a value for the HistoryID parameter and set the ForRendering parameter value to true, the parameter metadata returned represents the parameter data that was used when the report history snapshot was created. The value supplied for HistoryID is ignored if ForRendering is set to false. If ForRendering is false, the parameter metadata returned represents the parameter data that is currently associated with the specified report.

If any parameters values are based on a query and you are interested in returning the query-based parameters' valid values list, set ForRendering to true. In addition, for query-based parameters, you must pass in all the credential information that is required to return the query parameters.

When using the M:ReportService2006.ReportingService2006.GetReportParameters(System.String,System.String,System.Boolean,ReportService2006.ParameterValue[],ReportService2006.DataSourceCredentials[]) method to validate parameters, the Values parameter is required.

If report parameters do not exist for the given report, an empty ReportParameter array is returned.

using System;
using System.Collections.Generic;
using System.IO;
using System.Text;
using System.Web;
using System.Web.Services;
using System.Web.Services.Protocols;

class Sample
    static void Main(string[] args)
        ReportingService2006 rs = new ReportingService2006();
        rs.Url = "http://<Server Name>/_vti_bin/ReportServer/" +
        rs.Credentials = 

        string report = "http://<Server Name>/Docs/Documents" +
            "/AdventureWorks Sample Reports/" +
            "Employee Sales Summary.rdl";
        string historyID = null;
        ParameterValue[] values = null;
        DataSourceCredentials[] credentials = null;
        ReportParameter[] parameters = null;

            parameters = rs.GetReportParameters(report, historyID, 
                values, credentials);

            if (parameters != null)
                foreach (ReportParameter rp in parameters)
                    Console.WriteLine("Name: {0}", rp.Name);
        catch (SoapException e)
Return to top