@servicenow/sdk - v4.9.0
    Preparing search index...
    interface sys_ui_list_control {
        columns_condition: Typed<
            string
            | number,
            {
                columnType: "script_plain";
                label: [
                    {
                        hint: "If condition evaluates true, omit column headings if there are no entries";
                        label: "Omit columns condition";
                        language: "en";
                        plural: "Omit columns conditions";
                    },
                ];
                maxLength: 8000;
            },
        >;
        disable_nlq: Typed<
            boolean,
            {
                label: [
                    {
                        hint: "Disables the Natural Language Query from the filter.";
                        label: "Disable Natural Language Query (NLQ)";
                        language: "en";
                        plural: "Disable Natural Language Query (NLQ)";
                    },
                ];
            },
        >;
        edit_condition: Typed<
            string
            | number,
            {
                columnType: "script_plain";
                label: [
                    {
                        hint: "If condition evaluates true, omit button";
                        label: "Omit edit condition";
                        language: "en";
                        plural: "Omit edit conditions";
                    },
                ];
                maxLength: 8000;
            },
        >;
        edit_default_filter: Typed<string, { label: "Edit default filter" }>;
        edit_roles: Typed<
            (string | Role)[],
            {
                array: true;
                label: [
                    {
                        hint: "Roles necessary to see the Edit button";
                        label: "Edit roles";
                        language: "en";
                        plural: "Edit roles";
                    },
                ];
                maxLength: 40;
            },
        >;
        empty_condition: Typed<
            string
            | number,
            {
                columnType: "script_plain";
                label: [
                    {
                        hint: "If condition evaluates true, omit list header if there are no entries";
                        label: "Omit empty condition";
                        language: "en";
                        plural: "Omit empty conditions";
                    },
                ];
                maxLength: 8000;
            },
        >;
        filter_condition: Typed<
            string
            | number,
            {
                columnType: "script_plain";
                label: [
                    {
                        hint: "If condition evaluates true, omit filter";
                        label: "Omit filter condition";
                        language: "en";
                        plural: "Omit filter conditions";
                    },
                ];
                maxLength: 8000;
            },
        >;
        filter_roles: Typed<
            (string | Role)[],
            {
                array: true;
                label: [
                    {
                        hint: "Roles necessary to see filters";
                        label: "Filter roles";
                        language: "en";
                        plural: "Filter roles";
                    },
                ];
                maxLength: 40;
            },
        >;
        hierarchical_lists: Typed<
            boolean,
            {
                label: [
                    {
                        hint: "Show hierarchical lists";
                        label: "Hierarchical lists";
                        language: "en";
                        plural: "Hierarchal lists";
                    },
                ];
            },
        >;
        label: Typed<
            string,
            {
                label: [
                    {
                        hint: "Label used when displaying this list. If not supplied the default plural label for the file is used. (ex. the label for the incident is Incidents).";
                        label: "Label";
                        language: "en";
                        plural: "Labels";
                    },
                ];
            },
        >;
        link_condition: Typed<
            string
            | number,
            {
                columnType: "script_plain";
                label: [
                    {
                        hint: "If condition evaluates true, omit links";
                        label: "Omit links condition";
                        language: "en";
                        plural: "Omit links conditions";
                    },
                ];
                maxLength: 8000;
            },
        >;
        link_roles: Typed<
            (string | Role)[],
            {
                array: true;
                label: [
                    {
                        hint: "Roles necessary to drill into record";
                        label: "Link roles";
                        language: "en";
                        plural: "Link roles";
                    },
                ];
                maxLength: 40;
            },
        >;
        list_edit_insert_row: Typed<
            boolean,
            {
                default: false;
                label: [
                    {
                        hint: "Enable grid editing insert row functionality";
                        label: "List edit insert row";
                        language: "en";
                        plural: "List edit insert rows";
                    },
                ];
            },
        >;
        list_edit_ref_qual_tag: Typed<
            string,
            {
                label: [
                    {
                        hint: "Tag available to advanced reference qualifiers during list editing operations";
                        label: "List edit tag";
                        language: "en";
                        plural: "List edit tags";
                    },
                ];
            },
        >;
        list_edit_type: Typed<
            "NULL_OVERRIDE"
            | "save_by_row"
            | "disabled",
            {
                choices: {
                    disabled: { label: "Disable list editing"; sequence: 3 };
                    NULL_OVERRIDE: {
                        label: "Save immediately (cell edit mode)";
                        sequence: 1;
                    };
                    save_by_row: { label: "Save data by rows"; sequence: 2 };
                };
                dropdown: "dropdown_with_none";
                label: "List edit type";
            },
        >;
        name: Typed<
            keyof Tables,
            { label: "Table"; readOnly: true; tableReference: true },
        >;
        new_condition: Typed<
            string
            | number,
            {
                columnType: "script_plain";
                label: [
                    {
                        hint: "If condition evaluates true, omit button";
                        label: "Omit new condition";
                        language: "en";
                        plural: "Omit new conditions";
                    },
                ];
                maxLength: 8000;
            },
        >;
        new_roles: Typed<
            (string | Role)[],
            {
                array: true;
                label: [
                    {
                        hint: "Roles necessary to see the New button";
                        label: "New roles";
                        language: "en";
                        plural: "New roles";
                    },
                ];
                maxLength: 40;
            },
        >;
        omit_columns_if_empty: Typed<
            boolean,
            {
                label: [
                    {
                        hint: "Do not display column headings if there are no entries";
                        label: "Omit columns if empty";
                        language: "en";
                        plural: "Omit columns if empties";
                    },
                ];
            },
        >;
        omit_count: Typed<
            boolean,
            {
                label: [
                    {
                        hint: "Prevents list from getting full record count";
                        label: "Remove pagination count";
                        language: "en";
                        plural: "Remove pagination counts";
                    },
                ];
            },
        >;
        omit_count_views: Typed<
            boolean,
            {
                label: [
                    {
                        hint: "Prevent specific views from getting full record count";
                        label: "Remove pagination count for specific views";
                        language: "en";
                        plural: "Remove pagination count for specific views";
                    },
                ];
            },
        >;
        omit_count_views_list: Typed<
            string
            | string[]
            | Record<"sys_ui_view">[],
            {
                attributes: {
                    array: "denormalized";
                    no_sort: true;
                    slushbucket_ref_no_expand: true;
                };
                label: [
                    {
                        hint: "List of specific views where count will be removed";
                        label: "Specific list of views prevented from getting full record count";
                        language: "en";
                        plural: "Specific list of views prevented from getting full record counts";
                    },
                ];
                maxLength: 1024;
                referenceQual: "javascript: 'sys_idIN'+omitCountGetViews(current.name, current.related_list)";
                referenceTable: "sys_ui_view";
            },
        >;
        omit_drilldown_link: Typed<
            boolean,
            {
                label: [
                    {
                        hint: "Do not automatically render the first non-reference column as a drill-down link";
                        label: "Omit drill-down link";
                        language: "en";
                        plural: "Omit drill-down links";
                    },
                ];
            },
        >;
        omit_edit_button: Typed<
            boolean,
            {
                default: true;
                label: [
                    {
                        hint: "Do not display an Edit button for list if not part of a relationship";
                        label: "Omit edit button";
                        language: "en";
                        plural: "Omit edit buttons";
                    },
                ];
            },
        >;
        omit_filters: Typed<
            boolean,
            {
                label: [
                    {
                        hint: "Do not display any filters for list";
                        label: "Omit filters";
                        language: "en";
                        plural: "Omit filters";
                    },
                ];
            },
        >;
        omit_if_empty: Typed<
            boolean,
            {
                label: [
                    {
                        hint: "Do not display list header if there are no entries";
                        label: "Omit if empty";
                        language: "en";
                        plural: "Omit if empties";
                    },
                ];
            },
        >;
        omit_links: Typed<
            boolean,
            {
                label: [
                    {
                        hint: "Do not create links for reference elements in the list";
                        label: "Omit links";
                        language: "en";
                        plural: "Omit links";
                    },
                ];
            },
        >;
        omit_new_button: Typed<
            boolean,
            {
                label: [
                    {
                        hint: "Do not display a New button for list";
                        label: "Omit new button";
                        language: "en";
                        plural: "Omit new buttons";
                    },
                ];
            },
        >;
        omit_related_list_count: Typed<
            boolean,
            {
                label: [
                    {
                        hint: "Skip related list record count on form load within Workspace";
                        label: "Omit related list count";
                        language: "en";
                        plural: "Omit related list counts";
                    },
                ];
            },
        >;
        related_list: Typed<
            string,
            { label: "Related list"; maxLength: 160; readOnly: true },
        >;
        sys_domain: Typed<
            "global"
            | Record<"domain">,
            {
                default: "global";
                label: [
                    {
                        hint: "Domain to which the List Control belongs";
                        label: "Domain";
                        language: "en";
                        plural: "Domains";
                    },
                ];
            },
        >;
        sys_domain_path: Typed<
            string,
            {
                attributes: { case_sensitive: true };
                default: "/";
                label: "Domain Path";
            },
        >;
        sys_id: Typed<
            string
            | number,
            { columnType: "GUID"; label: "Sys ID"; maxLength: 32; primary: true },
        >;
        sys_overrides: Typed<
            | string
            | ExplicitKey<"sys_ui_list_control">
            | TableBrand<"sys_ui_list_control">
            | Record<"sys_ui_list_control">,
            {
                default: "global";
                label: [
                    {
                        hint: "List Control being overridden by the current record";
                        label: "Overrides";
                        language: "en";
                        plural: "Overrides";
                    },
                ];
                referenceTable: "sys_ui_list_control";
            },
        >;
    }

    Hierarchy (View Summary)

    Index

    Properties

    columns_condition: Typed<
        string
        | number,
        {
            columnType: "script_plain";
            label: [
                {
                    hint: "If condition evaluates true, omit column headings if there are no entries";
                    label: "Omit columns condition";
                    language: "en";
                    plural: "Omit columns conditions";
                },
            ];
            maxLength: 8000;
        },
    >
    disable_nlq: Typed<
        boolean,
        {
            label: [
                {
                    hint: "Disables the Natural Language Query from the filter.";
                    label: "Disable Natural Language Query (NLQ)";
                    language: "en";
                    plural: "Disable Natural Language Query (NLQ)";
                },
            ];
        },
    >
    edit_condition: Typed<
        string
        | number,
        {
            columnType: "script_plain";
            label: [
                {
                    hint: "If condition evaluates true, omit button";
                    label: "Omit edit condition";
                    language: "en";
                    plural: "Omit edit conditions";
                },
            ];
            maxLength: 8000;
        },
    >
    edit_default_filter: Typed<string, { label: "Edit default filter" }>
    edit_roles: Typed<
        (string | Role)[],
        {
            array: true;
            label: [
                {
                    hint: "Roles necessary to see the Edit button";
                    label: "Edit roles";
                    language: "en";
                    plural: "Edit roles";
                },
            ];
            maxLength: 40;
        },
    >
    empty_condition: Typed<
        string
        | number,
        {
            columnType: "script_plain";
            label: [
                {
                    hint: "If condition evaluates true, omit list header if there are no entries";
                    label: "Omit empty condition";
                    language: "en";
                    plural: "Omit empty conditions";
                },
            ];
            maxLength: 8000;
        },
    >
    filter_condition: Typed<
        string
        | number,
        {
            columnType: "script_plain";
            label: [
                {
                    hint: "If condition evaluates true, omit filter";
                    label: "Omit filter condition";
                    language: "en";
                    plural: "Omit filter conditions";
                },
            ];
            maxLength: 8000;
        },
    >
    filter_roles: Typed<
        (string | Role)[],
        {
            array: true;
            label: [
                {
                    hint: "Roles necessary to see filters";
                    label: "Filter roles";
                    language: "en";
                    plural: "Filter roles";
                },
            ];
            maxLength: 40;
        },
    >
    hierarchical_lists: Typed<
        boolean,
        {
            label: [
                {
                    hint: "Show hierarchical lists";
                    label: "Hierarchical lists";
                    language: "en";
                    plural: "Hierarchal lists";
                },
            ];
        },
    >
    label: Typed<
        string,
        {
            label: [
                {
                    hint: "Label used when displaying this list. If not supplied the default plural label for the file is used. (ex. the label for the incident is Incidents).";
                    label: "Label";
                    language: "en";
                    plural: "Labels";
                },
            ];
        },
    >
    link_condition: Typed<
        string
        | number,
        {
            columnType: "script_plain";
            label: [
                {
                    hint: "If condition evaluates true, omit links";
                    label: "Omit links condition";
                    language: "en";
                    plural: "Omit links conditions";
                },
            ];
            maxLength: 8000;
        },
    >
    link_roles: Typed<
        (string | Role)[],
        {
            array: true;
            label: [
                {
                    hint: "Roles necessary to drill into record";
                    label: "Link roles";
                    language: "en";
                    plural: "Link roles";
                },
            ];
            maxLength: 40;
        },
    >
    list_edit_insert_row: Typed<
        boolean,
        {
            default: false;
            label: [
                {
                    hint: "Enable grid editing insert row functionality";
                    label: "List edit insert row";
                    language: "en";
                    plural: "List edit insert rows";
                },
            ];
        },
    >
    list_edit_ref_qual_tag: Typed<
        string,
        {
            label: [
                {
                    hint: "Tag available to advanced reference qualifiers during list editing operations";
                    label: "List edit tag";
                    language: "en";
                    plural: "List edit tags";
                },
            ];
        },
    >
    list_edit_type: Typed<
        "NULL_OVERRIDE"
        | "save_by_row"
        | "disabled",
        {
            choices: {
                disabled: { label: "Disable list editing"; sequence: 3 };
                NULL_OVERRIDE: {
                    label: "Save immediately (cell edit mode)";
                    sequence: 1;
                };
                save_by_row: { label: "Save data by rows"; sequence: 2 };
            };
            dropdown: "dropdown_with_none";
            label: "List edit type";
        },
    >
    name: Typed<
        keyof Tables,
        { label: "Table"; readOnly: true; tableReference: true },
    >
    new_condition: Typed<
        string
        | number,
        {
            columnType: "script_plain";
            label: [
                {
                    hint: "If condition evaluates true, omit button";
                    label: "Omit new condition";
                    language: "en";
                    plural: "Omit new conditions";
                },
            ];
            maxLength: 8000;
        },
    >
    new_roles: Typed<
        (string | Role)[],
        {
            array: true;
            label: [
                {
                    hint: "Roles necessary to see the New button";
                    label: "New roles";
                    language: "en";
                    plural: "New roles";
                },
            ];
            maxLength: 40;
        },
    >
    omit_columns_if_empty: Typed<
        boolean,
        {
            label: [
                {
                    hint: "Do not display column headings if there are no entries";
                    label: "Omit columns if empty";
                    language: "en";
                    plural: "Omit columns if empties";
                },
            ];
        },
    >
    omit_count: Typed<
        boolean,
        {
            label: [
                {
                    hint: "Prevents list from getting full record count";
                    label: "Remove pagination count";
                    language: "en";
                    plural: "Remove pagination counts";
                },
            ];
        },
    >
    omit_count_views: Typed<
        boolean,
        {
            label: [
                {
                    hint: "Prevent specific views from getting full record count";
                    label: "Remove pagination count for specific views";
                    language: "en";
                    plural: "Remove pagination count for specific views";
                },
            ];
        },
    >
    omit_count_views_list: Typed<
        string
        | string[]
        | Record<"sys_ui_view">[],
        {
            attributes: {
                array: "denormalized";
                no_sort: true;
                slushbucket_ref_no_expand: true;
            };
            label: [
                {
                    hint: "List of specific views where count will be removed";
                    label: "Specific list of views prevented from getting full record count";
                    language: "en";
                    plural: "Specific list of views prevented from getting full record counts";
                },
            ];
            maxLength: 1024;
            referenceQual: "javascript: 'sys_idIN'+omitCountGetViews(current.name, current.related_list)";
            referenceTable: "sys_ui_view";
        },
    >
    omit_drilldown_link: Typed<
        boolean,
        {
            label: [
                {
                    hint: "Do not automatically render the first non-reference column as a drill-down link";
                    label: "Omit drill-down link";
                    language: "en";
                    plural: "Omit drill-down links";
                },
            ];
        },
    >
    omit_edit_button: Typed<
        boolean,
        {
            default: true;
            label: [
                {
                    hint: "Do not display an Edit button for list if not part of a relationship";
                    label: "Omit edit button";
                    language: "en";
                    plural: "Omit edit buttons";
                },
            ];
        },
    >
    omit_filters: Typed<
        boolean,
        {
            label: [
                {
                    hint: "Do not display any filters for list";
                    label: "Omit filters";
                    language: "en";
                    plural: "Omit filters";
                },
            ];
        },
    >
    omit_if_empty: Typed<
        boolean,
        {
            label: [
                {
                    hint: "Do not display list header if there are no entries";
                    label: "Omit if empty";
                    language: "en";
                    plural: "Omit if empties";
                },
            ];
        },
    >
    omit_links: Typed<
        boolean,
        {
            label: [
                {
                    hint: "Do not create links for reference elements in the list";
                    label: "Omit links";
                    language: "en";
                    plural: "Omit links";
                },
            ];
        },
    >
    omit_new_button: Typed<
        boolean,
        {
            label: [
                {
                    hint: "Do not display a New button for list";
                    label: "Omit new button";
                    language: "en";
                    plural: "Omit new buttons";
                },
            ];
        },
    >
    omit_related_list_count: Typed<
        boolean,
        {
            label: [
                {
                    hint: "Skip related list record count on form load within Workspace";
                    label: "Omit related list count";
                    language: "en";
                    plural: "Omit related list counts";
                },
            ];
        },
    >
    related_list: Typed<
        string,
        { label: "Related list"; maxLength: 160; readOnly: true },
    >
    sys_domain: Typed<
        "global"
        | Record<"domain">,
        {
            default: "global";
            label: [
                {
                    hint: "Domain to which the List Control belongs";
                    label: "Domain";
                    language: "en";
                    plural: "Domains";
                },
            ];
        },
    >
    sys_domain_path: Typed<
        string,
        {
            attributes: { case_sensitive: true };
            default: "/";
            label: "Domain Path";
        },
    >
    sys_id: Typed<
        string
        | number,
        { columnType: "GUID"; label: "Sys ID"; maxLength: 32; primary: true },
    >
    sys_overrides: Typed<
        | string
        | ExplicitKey<"sys_ui_list_control">
        | TableBrand<"sys_ui_list_control">
        | Record<"sys_ui_list_control">,
        {
            default: "global";
            label: [
                {
                    hint: "List Control being overridden by the current record";
                    label: "Overrides";
                    language: "en";
                    plural: "Overrides";
                },
            ];
            referenceTable: "sys_ui_list_control";
        },
    >