Magidoc

FormElementInput
Input Object

Input type for form elements (questions/fields) in a form Represents a single form element with all its properties

Fields

#

actionAttachments

Boolean

Whether to map field to action attachments

actionCustomField

Boolean

Whether to map field to action custom field

actionDescription

Boolean

Whether to map field to action description

availableLabels

FormAvailableLabels

Which labels a dynamic labels question offers: all (default) or only its specificLabels

choices

[String ]

Array of choices for dropdown, radiogroup, checkbox, etc.

Default: []

commentText

String

Label for additional comment field

commentValue

String

Default value for comment field

customFieldId

String

ID of custom field

customFieldItemType

String

Type of custom field

defaultDate

JSONObject

Default date configuration - can be either a string or an object with date settings

description

String

Help text shown under the title

detailElements

[FormElementInput ]

Nested form elements

Default: []

elements

[FormElementInput ]

Nested form elements for static panel

Default: []

emptyValuesToActionCustomField

Boolean

Whether to map empty values to action custom field

emptyValuesToActionDescription

Boolean

Whether to map empty values to action description

enableIf

String

Conditional enable expression

fieldId

String

Unique ID for the field, used for mapping and references

hasOther

Boolean

Whether to show 'Other' option

hasSelectAll

Boolean

Whether to show 'Select All' option

isRequired

Boolean

Whether the field is required

label

Boolean

Whether to add the labels picked in a dynamic labels question to the created action

mapActionCustomFieldTo

String

ID of custom field to map to in action

mapProjectCustomFieldTo

String

ID of custom field to map to in project

mapTo

String

Field mapping configuration

maxSize

Int

Maximum size for file uploads

multiple

Boolean

Whether multiple selections are allowed

name

String !
Non-null

Unique name identifier for the element

noneText

String

Text to display for the 'None' option

parentFieldId

String

ID of parent field for nested elements

projectCustomField

Boolean

Whether to map field to project custom field

readOnly

Boolean

Whether the field is read-only

recordFieldMappings

[JSONObject ]

Maps table column keys to form field names for prefill

Default: []

showNoneItem

Boolean

Whether to show a 'None' option

showOtherItem

Boolean

Whether to show the 'Other' item

showSelectAllItem

Boolean

Whether to show the 'Select All' item

sourceDisplayFieldKey

String

Table column key used as record picker display label

sourceSortOrder

FormTableRecordSortOrder

Display-label order; omitted on legacy questions

sourceTableId

String

Source Hive table id for dynamic table record picker

specificLabels

[String ]

Label IDs a dynamic labels question offers when availableLabels is specificLabels

Default: []

templateElements

[FormElementInput ]

Nested form elements for dynamic panel

Default: []

title

String

Display title for the element

type

String !
Non-null

The type of form element (text, dropdown, date, etc.)

values

[String ]

Array of values

Default: []

visibleIf

String

Conditional visibility expression

waitForUpload

Boolean

Whether to wait for upload completion