Bluestep JS Documentation
    Preparing search index...

    Interface UpdateFieldProperties

    Properties for updating an existing field.

    interface UpdateFieldProperties {
        columnSpan?: number;
        deprecated?: boolean;
        expectedVersion?: number;
        fieldControlFieldTopId?: string;
        fieldControlType?:
            | "NORMAL"
            | "HIDDEN_DEFAULT"
            | "READONLY_DEFAULT"
            | "SMART_HIDE"
            | "READONLY_WHEN_COMPLETED"
            | "CUSTOM";
        fieldControlValue?: string;
        fieldControlView?: "READONLY"
        | "HIDDEN";
        frozen?: boolean;
        helpText?: string;
        hiddenFromSupers?: boolean;
        label?: string;
        name?: string;
        typeScriptDeclarations?: string;
        userUpdateable?: boolean;
    }

    Hierarchy (View Summary)

    Index
    columnSpan?: number

    How many of its row's columns this field spans: 0 for the whole row, 1-4 for that many columns. An explicit null clears it, leaving the field type's default placement. Read by layout clients; legacy form pages do not apply it.

    deprecated?: boolean

    Whether this field is deprecated and hidden from new configurations

    expectedVersion?: number

    The field's rowVersion this write was decided against. At that version the write applies and bumps it; one past it with a payload that changes nothing — a replay of a write that already landed — answers success without another bump; anything else is refused with CONCURRENT_MODIFICATION and extensions.currentVersion. Omit to write unconditionally.

    fieldControlFieldTopId?: string

    ID of the field a CUSTOM fieldControlType watches: another checkbox, radio, signature or single-select field on the same form. Null or an empty ID removes it.

    fieldControlType?:
        | "NORMAL"
        | "HIDDEN_DEFAULT"
        | "READONLY_DEFAULT"
        | "SMART_HIDE"
        | "READONLY_WHEN_COMPLETED"
        | "CUSTOM"

    Visibility/editability control mode for this field

    fieldControlValue?: string

    The watched field's value at which a CUSTOM fieldControlType applies: true or false for a checkbox or radio, signed or unsigned for a signature, one of its option IDs for a single-select (an empty string, accepted for legacy compatibility, stores no value).

    fieldControlView?: "READONLY" | "HIDDEN"

    What a CUSTOM fieldControlType does to this field while its condition holds. A header, spacer, static content or merge report field can only be HIDDEN, which writing its condition stores.

    frozen?: boolean

    Whether this field is locked from editing by non-admin users

    helpText?: string

    Help text displayed below or beside the field

    hiddenFromSupers?: boolean

    Whether this field is hidden from parent/supervisor unit views

    label?: string

    Display label shown to users on the form

    name?: string

    Field name.

    typeScriptDeclarations?: string

    Type script declarations

    userUpdateable?: boolean

    Whether end users can edit this field value (false = system-managed)