Retrieve report parameters

Allows you to list and search for report templates.

URL

GET /api/v1/report/{TemplateID}/parameters

Optional parameters

Parameter can be passed in URL as ?param=value or form-encoded in the request body.

Name	Values	Default	Function
format	json/xml	xml	Defines the format with which the ReportDataParameter object is serialized.

Result

An array of the type ReportDataParameter (see below) is returned.

Error codes (in addition to general error codes)

Status code	Status text	Explanation
403	ERR_ACCESS_DENIED	No access rights to report template / data source.
404	ERR_INVALID_TEMPLATE	Report template not found.
520	-	Error during export. A localized error message is in the request body (XML/JSON).

ExportResult object: IEnumerable<ReportDataParameter>

An array of ReportDataParameters is returned.

ReportDataParameter
string	Guid	The globally unique identifier of this parameter.
string	ParentGuid	If not null, it is the identifier of the parameter on which this parameter depends.
string	Name	Name of the parameter.
string	HelpText	Text which helps to understand the usage of the parameter.
bool	IsVisible	Visibility of the parameter.
object	Value	Value of the parameter.
IEnumerable<Choice>	Choices	IF Parameter has NO dependencies (ParentGuid == null) available choices will be here.
bool	SelectMultiple	Whether you can select multiple items.
bool	MayBeEmpty	Whether you can select no item.
bool	MayBeNull	Whether this parameter is may be null / is required.
ReportDataParameterSourceMode	SourceMode	The Mode of the Source of this parameter.
ReportDataParameterSourceType	SourceType	The Type of the Source of this parameter.
ReportDataParameterControlType	ControlType	The kind of control the user should see for the parameter.

The control for a parameter

ReportDataParameterControlType
Text	z.B. TextField
Date	z.B. DatePicker
BoolYesNo	z.B. Switch, RadioButtons
BoolTrueFalse	z.B. Switch, RadioButtons
bool	z.B. DatePicker and TimePicker

The SourceMode of a ReportDataParameter

ReportDataParameterSourceMode
Database	Database Source
Choice	List of Choices
EditableText	Simple editable text

The SourceType of a ReportDataParameter

ReportDataParameterControlType
Text	String
Numeric	Numeric string
Date	DateTime
Boolean	Boolean value

If the SourceMode is Database or Choice AND the parameter has no dependencies (ParentGuid == null), then all available choices are available in the Property Choices.

A single choice:

Choice
string	Key	The variable name (e.g. "[LLvar]AvABAAA") of this selection. The server replaces the prefix "var://" with "[LLVar]" to avoid drawing problems.
string	Value	The value / name of this selection.
bool	IsSelected	Whether this selection is already selected.

Special feature for dependencies:

▪ use ParentGuid to find out the key of the parent parameter selection: "[LLvar]AvABAAA".

▪ [optional] If parent parameter also has parent parameter; find its key of selection:"[LLVar]AvACAAA"".

▪ query dependent selections (RS API v1)

Here is an example of parameters retrieved:

Second depends on First.

Third depends on Second and therefore also on First.

As XML

<Name>First</Name>

<IsVisible>false</IsVisible>

<Key>[LLVar]AwABAAAA</Key>

<Value>Beverages</Value>

</Choice>

<Key>[LLVar]AwACAAAA</Key>

<Value>Condiments</Value>