ReportParameterDto
A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.
A filter a report accepts in the `filters` object of a run.
Values
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
Fields
| Field | Type | Description |
|---|---|---|
name
required |
string | The key to send the filter under in `filters`. Stable once published.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
label
required |
string | The filter's display label.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
type
required |
string | The value type: `bool` takes `true` or `false`, `int` takes a whole number,
`enum` takes one of `options`, and any other type takes a string.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
isRequired
required |
boolean | Whether the report needs the filter to run.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
allowMultiple
required |
boolean | Whether the filter takes an array of values rather than a single value.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
helpText
required |
string | A short explanation of the filter, when the report provides one.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
defaultValue
required |
string | The value the report uses when the filter is not sent, as text, when it has one.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
options
required |
array of ReportParameterOptionDto array of ReportParameterOptionDto | The allowed values, for a filter that takes one of a fixed set.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
Fields of each ReportParameterOptionDto: This body has no documented fields. | ||
This model has no documented fields.