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

    Interface Table<S, E>

    interface Table<
        S extends TableColumn = TableColumn,
        E extends TableName | undefined = TableName | undefined,
    > {
        $override?: Record<string, string | number | boolean>;
        accessible_from?: "public" | "package_private";
        accessibleFrom?: "public" | "package_private";
        actions?: TableActionAccess | TableActionList;
        allow_client_scripts?: boolean;
        allow_new_fields?: boolean;
        allow_ui_actions?: boolean;
        allow_web_service_access?: boolean;
        allowClientScripts?: boolean;
        allowConfiguration?: boolean;
        allowNewFields?: boolean;
        allowUiActions?: boolean;
        allowWebServiceAccess?: boolean;
        attributes?: { [key: string]: string | number | boolean };
        audit?: boolean;
        augments?: string;
        auto_number?: {
            number?: number;
            number_of_digits?: number;
            prefix?: string;
        };
        autoNumber?: { number?: number; numberOfDigits?: number; prefix?: string };
        caller_access?: "none" | "tracking" | "restricted";
        callerAccess?: "none" | "tracking" | "restricted";
        createAccessControls?: boolean;
        display?: string;
        extends?: E;
        extensible?: boolean;
        index?:
            | {
                element: string & {}
                | keyof S
                | (keyof S)[]
                | (string & {})[];
                name?: string;
                unique: boolean;
            }[]
            | {
                element: string & {}
                | keyof S
                | (keyof S)[]
                | (string & {})[];
                name?: string;
                unique: boolean;
            }[];
        label?: string
        | Documentation[];
        licensing_config?: LicensingConfig;
        licensingConfig?: LicensingConfig;
        live_feed?: boolean;
        liveFeed?: boolean;
        name?: string;
        protectionPolicy?: "read" | "protected";
        read_only?: boolean;
        readOnly?: boolean;
        schema: S;
        scriptable_table?: boolean;
        scriptableTable?: boolean;
        text_index?: boolean;
        textIndex?: boolean;
        userRole?: string | Role | Record<"sys_user_role">;
    }

    Type Parameters

    Index

    Properties

    $override? accessible_from? accessibleFrom? actions? allow_client_scripts? allow_new_fields? allow_ui_actions? allow_web_service_access? allowClientScripts? allowConfiguration? allowNewFields? allowUiActions? allowWebServiceAccess? attributes? audit? augments? auto_number? autoNumber? caller_access? callerAccess? createAccessControls? display? extends? extensible? index? label? licensing_config? licensingConfig? live_feed? liveFeed? name? protectionPolicy? read_only? readOnly? schema scriptable_table? scriptableTable? text_index? textIndex? userRole?

    Properties

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

    Set properties not directly supported by this API.

    accessible_from?: "public" | "package_private"

    Use accessibleFrom instead

    accessibleFrom?: "public" | "package_private"

    Application scopes that can access the table.

    actions?: TableActionAccess | TableActionList

    Access options for the table. Only the actions you set are written to the table's metadata; an action you leave out is not written at all.

    Prefer the object form, { read: true, create: false }. The array form is deprecated because it is a complete enumeration: every action it leaves out is written as false.

    allow_client_scripts?: boolean

    Use allowClientScripts instead

    allow_new_fields?: boolean

    Use allowNewFields instead

    allow_ui_actions?: boolean

    Use allowUiActions instead

    allow_web_service_access?: boolean

    Use allowWebServiceAccess instead

    allowClientScripts?: boolean

    Indicates whether to allow design time configuration of client scripts on the table from other application scopes.

    allowConfiguration?: boolean

    Indicates whether to allow design time configuration of the table itself from other application scopes.

    allowNewFields?: boolean

    Indicates whether to allow design time configuration of new fields on the table from other application scope.

    allowUiActions?: boolean

    Indicates whether to allow design time configuration of UI Actions on the table from other application scopes.

    allowWebServiceAccess?: boolean

    Indicates whether web services can make calls to the table.

    attributes?: { [key: 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.

    augments?: string

    The name of an existing table to augment by adding columns

    auto_number?: { number?: number; number_of_digits?: number; prefix?: string }

    Use autoNumber instead

    autoNumber?: { number?: number; numberOfDigits?: number; prefix?: string }

    Auto-numbering configuration for the table.

    https://docs.servicenow.com/csh?topicname=table-api-now-ts.html&version=latest

    caller_access?: "none" | "tracking" | "restricted"

    Use callerAccess instead

    callerAccess?: "none" | "tracking" | "restricted"

    Access level for cross-scope requests.

    createAccessControls?: boolean

    Indicates whether to create access controls when the table is created.

    display?: string

    Default display column. Use a column name from the schema.

    extends?: E

    The name of any other table on which this table is based.

    extensible?: boolean

    Indicates whether other tables can extend this table.

    index?:
        | {
            element: string & {}
            | keyof S
            | (keyof S)[]
            | (string & {})[];
            name?: string;
            unique: boolean;
        }[]
        | {
            element: string & {}
            | keyof S
            | (keyof S)[]
            | (string & {})[];
            name?: string;
            unique: boolean;
        }[]

    A list of column references to generate indexes in the metadata XML of the table.

    Type Declaration

    • {
          element: string & {} | keyof S | (keyof S)[] | (string & {})[];
          name?: string;
          unique: boolean;
      }[]
      • element: string & {} | keyof S | (keyof S)[] | (string & {})[]

        Column references that make up the index.

      • Optionalname?: string

        Name of the index.

      • unique: boolean

        Whether the index is unique.

    • {
          element: string & {} | keyof S | (keyof S)[] | (string & {})[];
          name?: string;
          unique: boolean;
      }[]
      • element: string & {} | keyof S | (keyof S)[] | (string & {})[]

        Column references that make up the index.

      • Optionalname?: string

        Name of the index.

      • unique: boolean

        Whether the index is unique.

    label?: string | Documentation[]

    A unique label for the table on list and form views.

    licensing_config?: LicensingConfig

    Use licensingConfig instead

    licensingConfig?: LicensingConfig

    Configuration for table licensing.

    live_feed?: boolean

    Use liveFeed instead

    liveFeed?: boolean

    Indicates if live feeds are available for records in the table.

    name?: string

    Name of the table. Must be lowercase and include the application scope.

    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 users can edit fields in the table.

    schema: S

    Array of column references that define the table's schema

    scriptable_table?: boolean

    use scriptableTable instead

    scriptableTable?: boolean

    Indicates whether the table is a remote table that uses data retrieved from an external source.

    Optionaltext_index

    text_index?: boolean

    Use textIndex instead

    textIndex?: boolean

    Indicates whether search engines index the text in a table.

    userRole?: string | Role | Record<"sys_user_role">

    Role used to wire the table's auto-generated access controls. Accepts a role name (created on-demand via the platform's dynamic_creation script if it does not yet exist) or a reference to an existing sys_user_role record. When omitted, the platform falls back to the parent application's user_role.

    Only takes effect when createAccessControls is true.

    Settings

    Member Visibility

    On This Page

    Properties