Interface IUpdateFieldDefinitionRequest

Request body for partial-update of an existing field definition. Every property is optional. null = leave the property unchanged. Empty string ("") on a string property = clear the value. FieldType cannot be changed via this endpoint — use the ChangeFieldType endpoint. ListValues cannot be changed via this endpoint — use the dedicated ListValues endpoints.

interface IUpdateFieldDefinitionRequest {
    autoExtract?: boolean;
    constraint?: string;
    constraintError?: string;
    currency?: string;
    defaultValue?: string;
    description?: string;
    format?: FieldFormat;
    formatPattern?: string;
    hideListValues?: boolean;
    isIndexed?: boolean;
    isIndexedForReporting?: boolean;
    isMultiValue?: boolean;
    isRequired?: boolean;
    length?: number;
    name?: string;
    warnIfBlank?: boolean;
}

Implemented by

Properties

autoExtract? constraint? constraintError? currency? defaultValue? description? format? formatPattern? hideListValues? isIndexed? isIndexedForReporting? isMultiValue? isRequired? length? name? warnIfBlank?

Properties

OptionalautoExtract

autoExtract?: boolean

Whether values for this field can be automatically extracted by AI/OCR services.

Optionalconstraint

constraint?: string

A validation constraint expression for values stored in this field.

OptionalconstraintError

constraintError?: string

The error message returned when the constraint is violated.

Optionalcurrency

currency?: string

The currency for numeric fields when Format is Currency.

OptionaldefaultValue

defaultValue?: string

The default value applied to entries assigned to a template containing this field.

Optionaldescription

description?: string

The description of the field.

Optionalformat

format?: FieldFormat

The display format for the field.

OptionalformatPattern

formatPattern?: string

The custom format pattern.

OptionalhideListValues

hideListValues?: boolean

Whether list values should be hidden in the UI. Applies only to list-backed fields.

OptionalisIndexed

isIndexed?: boolean

Whether the field is indexed for searching.

OptionalisIndexedForReporting

isIndexedForReporting?: boolean

Whether the field is indexed for reporting.

OptionalisMultiValue

isMultiValue?: boolean

Whether the field supports multiple values.

OptionalisRequired

isRequired?: boolean

Whether the field is required on entries assigned to a template containing it.

Optionallength

length?: number

The maximum length of the field for variable-length data types.

Optionalname

name?: string

The new name of the field. Must be unique within the repository.

OptionalwarnIfBlank

warnIfBlank?: boolean

Whether the user should be warned when leaving the field blank.

Settings

Member Visibility

On This Page

Properties