GET api/reportserver/reports/{reportId}/parameters

Gets the report parameters for the specified report.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
reportId

Report ID.

string

Required

Body Parameters

None.

Response Information

Resource Description

Collection of ReportParameter
NameDescriptionTypeAdditional information
Name

Gets or sets the name of the parameter. Used to access the parameter.

string

None.

Type

Gets or sets the data type of the parameter.

string

None.

Value

Gets or sets the value of the parameter. Can be an Expression that evaluates to an object, value of the allowed types, or containing values of the allowed types.

Object

None.

Mergeable

Gets or sets a value indicating whether this parameter should be merged with identical parameters from other reports when this report is part of a Telerik.Reporting.ReportBook.

boolean

None.

Text

Gets or sets the text for the parameter's automatic UI displayed in the report viewer. Can be an Expression that evaluates to a string.

string

None.

Visible

Determines whether automatic user interface (UI) prompting for values to be generated for the parameter.

boolean

None.

MultiValue

Determines if the parameter can hold more then one value.

boolean

None.

AllowNull

Determines if the parameter allows no value to be passed from it's editor.

boolean

None.

AllowBlank

Gets or sets a value that indicates whether an empty string is a valid value for the parameter. Only for parameters of String.

boolean

None.

AutoRefresh

Determines whether to trigger the report preview after changing the value for a parameter. Applies only for visible parameters.

boolean

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "Name": "sample string 1",
    "Type": "sample string 2",
    "Value": {},
    "Mergeable": true,
    "Text": "sample string 5",
    "Visible": true,
    "MultiValue": true,
    "AllowNull": true,
    "AllowBlank": true,
    "AutoRefresh": true
  },
  {
    "Name": "sample string 1",
    "Type": "sample string 2",
    "Value": {},
    "Mergeable": true,
    "Text": "sample string 5",
    "Visible": true,
    "MultiValue": true,
    "AllowNull": true,
    "AllowBlank": true,
    "AutoRefresh": true
  }
]
In this article
Not finding the help you need?