Typescript SDK Type Docs
    Preparing search index...

    Interface FieldDefinition

    Defines a Custom Field and its meta-information. Maps to Type.FieldDefinition.

    interface FieldDefinition {
        inputHint?: TypeTextInputHint;
        label: LocalizedString;
        name: string;
        required: boolean;
        type: FieldType;
    }
    Index

    Properties

    inputHint?: TypeTextInputHint

    Provides a visual representation type for this field. It is only relevant for string-based field types like CustomFieldStringType and CustomFieldLocalizedStringType.

    A human-readable label for the field.

    name: string

    Name of the Custom Field that you want to define. The name must be unique for a given ResourceTypeId. If a FieldDefinition with the same name is defined in another Type for the same ResourceTypeId, then both FieldDefinitions must have the same type. This value can't be changed after you import the Type.

    required: boolean

    Defines whether the field is required to have a value. This value cannot be changed after the Type is imported.

    type: FieldType

    Data type of the Custom Field to define.