ParameterInput is used is an input datatype for a parameter.

This datatype is used by two other datatypes: CreateDashboardInput, which is used by the createDashboard() mutation field; and UpdateDashboardInput, which is used by the updateDashboard() mutation.

Table: ParameterInput

ParameterTypeRequiredDefaultStabilityDescription
Some input parameters may be required, as indicated in the Required column. For return values, this indicates that you are assured a value if the field is requested for the results.
Table last updated: Sep 19, 2024
defaultValuestring  Long-TermThe default parameter value.
fixedListOptionsParameterFixedListPropertiesInput  Long-TermA fixed list of options. See ParameterFixedListPropertiesInput.
fileOptionsParameterFilePropertiesInput  Long-TermThe file options. See ParameterFilePropertiesInput Table.
freeTextOptionsParameterFreeTextPropertiesInput  Long-TermThe free text options. See ParameterFreeTextPropertiesInput.
idstringyes Long-TermThe unique identifier of the parameter.
labelstringyes Long-TermThe label associated with the parameter.
orderinteger  Long-TermHow parameters are to be ordered, sorted.
queryOptionsParameterQueryPropertiesInput  Long-TermAny query options. See ParameterQueryPropertiesInput.
widthinteger  Long-TermThe character width of the parameter.