ParameterInput
is used to
input data for a parameter.
Table: ParameterInput
Parameter | Type | Required | Default | Stability | Description |
---|---|---|---|---|---|
Some arguments may be required, as indicated in the Required column. For some fields, this column indicates that a result will always be returned for this column. | |||||
Table last updated: Sep 19, 2024 | |||||
defaultValue | string | Long-Term | The default parameter value. | ||
fixedListOptions | ParameterFixedListPropertiesInput | Long-Term | A fixed list of options. See ParameterFixedListPropertiesInput . | ||
fileOptions | ParameterFilePropertiesInput | Long-Term | The file options. See ParameterFilePropertiesInput Table. | ||
freeTextOptions | ParameterFreeTextPropertiesInput | Long-Term | The free text options. See ParameterFreeTextPropertiesInput . | ||
id | string | yes | Long-Term | The unique identifier of the parameter. | |
label | string | yes | Long-Term | The label associated with the parameter. | |
order | integer | Long-Term | How parameters are to be ordered, sorted. | ||
queryOptions | ParameterQueryPropertiesInput | Long-Term | Any query options. See ParameterQueryPropertiesInput . | ||
width | integer | Long-Term | The character width of the parameter. |