Bluestep JS Documentation
    Preparing search index...

    Interface UpdateFieldProperties

    Properties for updating an existing field.

    interface UpdateFieldProperties {
        deprecated?: boolean;
        expectedVersion?: number;
        fieldControlType?:
            | "NORMAL"
            | "HIDDEN_DEFAULT"
            | "READONLY_DEFAULT"
            | "SMART_HIDE"
            | "READONLY_WHEN_COMPLETED"
            | "CUSTOM";
        frozen?: boolean;
        hiddenFromSupers?: boolean;
        label?: string;
        name?: string;
        typeScriptDeclarations?: string;
        userUpdateable?: boolean;
    }

    Hierarchy (View Summary)

    Index
    deprecated? expectedVersion? fieldControlType? frozen? hiddenFromSupers? label? name? typeScriptDeclarations? userUpdateable?
    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.

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

    Visibility/editability control mode for this field

    frozen?: boolean

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

    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)

    Settings
    Member Visibility

    On This Page
    Properties