@servicenow/sdk - v4.7.0
    Preparing search index...

    Interface Column<Type, Default>

    interface Column<Type = unknown, Default extends Type = Type> {
        __type__?: Type;
        $override?: Record<string, string | number | boolean>;
        active?: boolean;
        array?: boolean;
        attributes?: Record<string, string | number | boolean>;
        audit?: boolean;
        default?: string | Default;
        dependent?: string;
        element_reference?: boolean;
        elementReference?: boolean;
        formula?: string;
        function_definition?: string;
        functionDefinition?: string;
        help?: string;
        hint?: string;
        label?: string | Documentation[];
        mandatory?: boolean;
        maxLength?: string | number;
        plural?: string;
        primary?: boolean;
        protectionPolicy?: "read" | "protected";
        read_only?: boolean;
        readOnly?: boolean;
        readOnlyOption?:
            | "instance_configured"
            | "display_read_only"
            | "client_script_modifiable"
            | "strict_read_only";
        spell_check?: boolean;
        spellCheck?: boolean;
        table_reference?: boolean;
        tableReference?: boolean;
        text_index?: boolean;
        textIndex?: boolean;
        unique?: boolean;
        virtualType?: "formula"
        | "script";
        widget?: string;
        xml_view?: boolean;
        xmlView?: boolean;
    }

    Type Parameters

    • Type = unknown
    • Default extends Type = Type
    Index

    Properties

    __type__? $override? active? array? attributes? audit? default? dependent? element_reference? elementReference? formula? function_definition? functionDefinition? help? hint? label? mandatory? maxLength? plural? primary? protectionPolicy? read_only? readOnly? readOnlyOption? spell_check? spellCheck? table_reference? tableReference? text_index? textIndex? unique? virtualType? widget? xml_view? xmlView?

    Properties

    Optional Readonly__type__

    __type__?: Type
    $override?: Record<string, string | number | boolean>

    Set properties not directly supported by this API.

    active?: boolean

    Indicates whether to display the field in list and forms

    array?: boolean

    Creates another table to store the info that will be captured by this field

    attributes?: Record<string, string | number | boolean>

    Pairs of any supported dictionary attributes (sys_schema_attribute)

    audit?: boolean

    Indicates whether to track the creation, update, and deletion of all records in the table.

    default?: string | Default

    Default value of the field when creating a record

    dependent?: string

    limit the values available to select based on the value of the dependent field

    element_reference?: boolean

    Use elementReference instead

    elementReference?: boolean

    Indicates if the value of this field connotes the "element type"

    formula?: string

    Formula script for a formula-type virtual field. Sets virtual=true and virtual_type='formula'. Mutually exclusive with dynamicValueDefinitions of type 'calculated_value', which uses virtual_type='script'.

    function_definition?: string

    Use functionDefinition instead

    functionDefinition?: string

    Definition of a function that the field performs

    help?: string

    Help information for the field

    hint?: string

    Describes field in more verbose form

    label?: string | Documentation[]

    Unique label for the column that appears on list headers and form fields

    mandatory?: boolean

    Indicates whether the field must contain a value to save a record

    maxLength?: string | number

    Maximum length of the field value

    plural?: string

    Plural form of the field name

    primary?: boolean

    Indicates the primary key for a table

    protectionPolicy?: "read" | "protected"

    Controls edit/view access for other developers after the application is installed.

    • read: Others can see the script logic but not change it.
    • protected: Others cannot change this record.
    • Omit to allow other developers to customize this record.
    read_only?: boolean

    Use readOnly instead

    readOnly?: boolean

    Indicates whether you can edit the field value. Equivalent to readOnlyOption: 'instance_configured'. Prefer readOnlyOption when you need a non-default behavior such as 'display_read_only', 'client_script_modifiable', or 'strict_read_only'.

    readOnlyOption?:
        | "instance_configured"
        | "display_read_only"
        | "client_script_modifiable"
        | "strict_read_only"

    Specifies the read-only behavior for the field. Preferred over readOnly because it is more expressive: in addition to the default 'instance_configured' (equivalent to readOnly: true), it lets you choose 'display_read_only', 'client_script_modifiable', or 'strict_read_only'.

    spell_check?: boolean

    Use spellCheck instead

    spellCheck?: boolean

    Enables spell check for this field

    table_reference?: boolean

    Use tableReference instead

    tableReference?: boolean

    Indicates if the value of this field is a reference to another table in the schema

    Optionaltext_index

    text_index?: boolean

    Use textIndex instead

    textIndex?: boolean

    Enables a natural language search on this field

    unique?: boolean

    Creates a unique index on this field

    virtualType?: "formula" | "script"

    Specifies the type of virtual/calculated field. Derived automatically: 'formula' when formula is set, 'script' when dynamicValueDefinitions type is 'calculated_value'. Only set explicitly to override.

    widget?: string

    Style for the element type such as "radio"

    xml_view?: boolean

    Use xmlView instead

    xmlView?: boolean

    Displays the field value as XML

    Settings

    Member Visibility

    On This Page

    Properties