Returns the fields you can write to the case's extended_fields. The case determines the owner and any applied template. The response includes the owner's global fields (library-wide) and, if the case has a template, that template's fields. Requires the Cases feature to be enabled in the space.
The UI control for the field, such as INPUT_TEXT, INPUT_NUMBER, SELECT_BASIC, TOGGLE, or MARKDOWN.
defaultValuestring
The default value, as a string, when the field definition declares one.
displayOnlybooleanrequired
When true the field is display-only (for example a MARKDOWN block): it is returned so the full form shape is visible, but it holds no value and its key cannot be written to extended_fields.
isGlobalbooleanrequired
Whether the field is a global (library-wide) definition.
keystringrequired
The storage key to write in the case extended_fields map. Follows the <field_name>_as_<storage_type> convention (for example priority_as_keyword).
labelstringrequired
The human-readable label. Falls back to name when no label is authored.
namestringrequired
The field name as authored in the field definition.
optionsstring[]
The allowed values for SELECT_BASIC, RADIO_GROUP, and CHECKBOX_GROUP fields.
typestringrequired
The storage type: keyword, integer, long, boolean, or date.
requiredbooleanrequired
Whether a value must be supplied at write time.
requiredOnClosebooleanrequired
Whether the field must be filled before the case can be closed.
sourceenumrequired
Where the field comes from: global for a library-wide (isGlobal) definition writable on any case, or template for a field contributed by the applied template.