|
Parameter
|
Valid Values
|
Required
|
|
id
|
The ID of the option. The ID is used to identify the option when setting or fetching the option value when referencing a data source.
|
Yes
|
|
displayName
|
A user-friendly name for the option that can be used in UI displays and other cases where the option is exposed to the end user.
|
Yes
|
|
documentation
|
A brief description of the option that can be displayed as help text for the end user.
|
No
|
|
required
|
If set to true, a value must be set for the option when creating or updating a data source. If set to false or not specified, the option is not required.
|
No
|
|
type
|
The data type of the option. Currently, the following data types are supported
 boolean
string
integer
password. An option with a data type of password indicates that the value for this option contains sensitive information such as a password or security token. Applications should provide the appropriate precautions when displaying a value with the password data type.
|
Yes
|
|
default
|
The value used for the option if a value is not specified for the data source.
|
No
|
|
choices
|
An array of choice-definition objects that define the set of valid values for the option. A string option may be restricted to a set of one or more valid string values.
A choice-definition object has the format:
{ "id": <choice-value>, "name": <display-value> }
See choice-definition Object for more information.
|
No
|