LinenoteChoiceParameterDto Data Type

Represents descriptive data of a ChoiceParameterDescriptor.

Properties
name data type description
name string Parameter name. Used in construction of a parameterized linenote.
description string Parameter description. Used in composing the user interface by providing human readable descripton of the represented parameter.
value string Parameter default value. Default value of the represented parameter.
type ChoiceParameterType Represented parameter type. See ChoiceValueParameterParser#getType() of the associated ChoiceParameterDescriptor#valueParser().
enumeration array of LinenoteChoiceParameterValueDto Possible values for enumerated parameters (enums). Note that this element is not used for non-enumerated parameters.

Example

{
  "name" : "...",
  "description" : "...",
  "value" : "...",
  "type" : "DOUBLE",
  "enumeration" : [ {
    "value" : "...",
    "description" : "..."
  }, {
    "value" : "...",
    "description" : "..."
  } ]
}