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

    Type Alias Column<Type, Default>

    Column: Typed<
        Type,
        {
            active?: boolean;
            array?: boolean;
            attributes?: Record<string, string | number | boolean>;
            audit?: boolean;
            default?: Default | string;
            dependent?: string;
            help?: string;
            hint?: string;
            label?: string | Documentation[];
            mandatory?: boolean;
            maxLength?: number | string;
            plural?: string;
            primary?: boolean;
            readOnlyOption?: readOnlyOptionType;
            unique?: boolean;
            widget?: string;
        } & (
            | {
                element_reference?: never;
                elementReference?: boolean;
                function_definition?: never;
                functionDefinition?: string;
                read_only?: never;
                readOnly?: boolean;
                spell_check?: never;
                spellCheck?: boolean;
                table_reference?: never;
                tableReference?: boolean;
                text_index?: never;
                textIndex?: boolean;
                xml_view?: never;
                xmlView?: boolean;
            }
            | {
                element_reference?: boolean;
                elementReference?: never;
                function_definition?: string;
                functionDefinition?: never;
                read_only?: boolean;
                readOnly?: never;
                spell_check?: boolean;
                spellCheck?: never;
                table_reference?: boolean;
                tableReference?: never;
                text_index?: boolean;
                textIndex?: never;
                xml_view?: boolean;
                xmlView?: never;
            }
        ),
    >

    Create a column in a table (sys_dictionary)

    Type Parameters

    • Type = unknown
    • Default extends Type = Type

    an object containing the following properties:

    • active? - indicates whether to display the field in list and forms
    • attributes? - pairs of any supported dictionary attributes (sys_schema_attribute)
    • audit?
    • default? - default value of the field when creating a record
    • functionDefinition? - definition of a function that the field performs
    • label? - unique label for the column that appears on list headers and form fields
    • mandatory? - indicates whether the field must contain a value to save a record
    • readOnly? - indicates whether you can edit the field value
    • plural? - plural for field
    • hint? - describes field in more verbose form
    • help? - help information for the field
    • widget? - style for the element type such as "radio"
    • tableReference? - value of this field is a reference to another table in the schema
    • elementReference? - value of this field connotes the "element type"
    • unique? - system creates index on this field on install
    • spellCheck? - display spell check icon
    • xmlView? - show text as xml
    • array? -Creates another table to store the info that will be captured by this field
    • textIndex? - Enables a natural language search on this field.
    • primary? - Indicates the primary key for a table