PickListAttribute

Template attributes of this type represent values that have a small set of allowed options. Shibumi supports three types of picklists:

• Simple Picklists: The user can pick from a small set of options; normally displayed as a dropdown. In this case, pickListMultiSelect is false, and pickListValueType is null.
• Multi-Select Picklists: The user can choose multiple values from a small set of options. In this case, pickListMultiSelect is true, and pickListValueType is null.
• Name / Value Picklists: The user can pick from a small set of options; normally displayed as a dropdown. Additionally, each human-readable option is mapped to a value behind the scenes, typically for use in calculations or exports. In this case, pickListMultiSelect is false, and pickListValueType is set.

Shibumi does not support any attributes where both pickListMultiSelect is true, and pickListValueType is non-null.

For name / value picklists in Shibumi, two options may have the same value, but they will never have the same name. For that reason, the human-readable name should be used as the unique identifier for an option, not its value. For the same reason, API calls that fetch or update name / value picklist fields typically use the option name, rather than its value.

Implements

• TemplateAttribute

Fields

apiName (String!)
The api name for this attribute. The api name uniquely identifies this attribute within its template, and it can be used to refer to the attribute from expressions.

name (String)
The human-readable name of the attribute. This may not be unique, and may change over time.

type (TemplateAttributeType!)
The type of attribute.

writeable (Boolean!)
Some built-in attributes that come with every template are fundamentally read-only: they can never be written to, regardless of configuration. For those attributes, this flag is false.

pickListMultiSelect (Boolean!)
This picklist supports selecting multiple values.

pickListHasIcon (String) Flag for determining if the picklist contains icon specific data in pickListValues.

pickListValueType (TemplateAttributePickListValueType)
If this field is non-null, the picklist supports associating a value with each human-readable name. In that case, the value of this attribute describes the datatype of the value.

pickListOptions (String!)
This field contains the allowed values for the picklist. For name / value picklists, this field returns the option names.

pickListValues ([TemplateAttributePickListValue!])
This field contains additional information about each pick list option.