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

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

Properties

inputHint?: string

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 to define. Must be unique for a given ResourceTypeId. In case there is a FieldDefinition with the same name in another Type, both FieldDefinitions must have the same type. This value cannot be changed after the Type is imported.

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.