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

    Interface List<T>

    interface List<T extends TableName = TableName> {
        $id?: string | number | ExplicitKey<string>;
        $meta?: { installMethod?: "first install" | "demo" | "once" };
        $override?: Record<string, string | number | boolean>;
        columns: (string & {} | ListElement<T> | TableSchemaDotWalk<T>)[];
        parent?: keyof Tables;
        protectionPolicy?: "read" | "protected";
        relationship?: string | Record<"sys_relationship">;
        table: T;
        view: string | Record<"sys_ui_view">;
    }

    Type Parameters

    Index

    Properties

    $id? $meta? $override? columns parent? protectionPolicy? relationship? table view

    Properties

    $id?: string | number | ExplicitKey<string>

    List IDs are now derived from the other fields. The explicit $id is no longer used.

    $meta?: { installMethod?: "first install" | "demo" | "once" }

    Type Declaration

    • OptionalinstallMethod?: "first install" | "demo" | "once"

      Map a record to an output folder that loads only in specific circumstances. 'first install' -> 'unload' (only loaded when plugin is first registered), 'demo' -> 'unload.demo' (only loaded when demo data is loaded), 'once' -> 'apply_once' (scripts that are only applied once)

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

    Set properties not directly supported by this API.

    columns: (string & {} | ListElement<T> | TableSchemaDotWalk<T>)[]

    An array of columns in the table to display in the list

    parent?: keyof Tables

    The table on which the related list appears

    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.
    relationship?: string | Record<"sys_relationship">

    The relationship to apply to the related list

    table: T

    Name of the table for the list

    view: string | Record<"sys_ui_view">

    The UI view (sys_ui_view) to apply to the list (reference record or name of the UI View)

    Settings

    Member Visibility

    On This Page

    Properties