Type Alias Table<S, E>

Table: {
    actions?: ("read" | "update" | "delete" | "create")[];
    attributes?: Record<string, string | number | boolean>;
    audit?: boolean;
    display?: string;
    extends?: E;
    extensible?: boolean;
    index?: {
        element: (keyof S)[] | keyof S | string & {} | (string & {})[];
        name: string;
        unique: boolean;
    }[];
    label?: string
    | Documentation[];
    name: string;
    schema: S;
} & (
    | {
        accessible_from?: never;
        accessibleFrom?: "public"
        | "package_private";
        allow_client_scripts?: never;
        allow_new_fields?: never;
        allow_ui_actions?: never;
        allow_web_service_access?: never;
        allowClientScripts?: boolean;
        allowNewFields?: boolean;
        allowUiActions?: boolean;
        allowWebServiceAccess?: boolean;
        auto_number?: never;
        autoNumber?: { number?: number; numberOfDigits?: number; prefix?: string };
        caller_access?: never;
        callerAccess?: "none" | "tracking" | "restricted";
        licensing_config?: never;
        licensingConfig?: LicensingConfig;
        live_feed?: never;
        liveFeed?: boolean;
        read_only?: never;
        readOnly?: boolean;
        scriptable_table?: never;
        scriptableTable?: boolean;
        text_index?: never;
        textIndex?: boolean;
    }
    | {
        accessible_from?: "public"
        | "package_private";
        accessibleFrom?: never;
        allow_client_scripts?: boolean;
        allow_new_fields?: boolean;
        allow_ui_actions?: boolean;
        allow_web_service_access?: boolean;
        allowClientScripts?: never;
        allowNewFields?: never;
        allowUiActions?: never;
        allowWebServiceAccess?: never;
        auto_number?: {
            number?: number;
            number_of_digits?: number;
            prefix?: string;
        };
        autoNumber?: never;
        caller_access?: "none"
        | "tracking"
        | "restricted";
        callerAccess?: never;
        licensing_config?: LicensingConfig;
        licensingConfig?: never;
        live_feed?: boolean;
        liveFeed?: never;
        read_only?: boolean;
        readOnly?: never;
        scriptable_table?: boolean;
        scriptableTable?: never;
        text_index?: boolean;
        textIndex?: never;
    }
)

Creates a table in a scoped application (sys_db_object).

Type Parameters

S extends Record<string, Column> = Record<string, Column>
E extends TableName | undefined = TableName | undefined

Type Declaration

Optionalactions?: ("read" | "update" | "delete" | "create")[]
List of access options for the table.
Optionalattributes?: Record<string, string | number | boolean>
Pairs of any supported dictionary attributes (sys_schema_attribute).
Optionalaudit?: boolean
Indicates whether to track the creation, update, and deletion of all records in the table.
Optionaldisplay?: string
Default display column. Use a column name from the schema.
Optionalextends?: E
The name of any other table on which this table is based.
Optionalextensible?: boolean
Indicates whether other tables can extend this table.
Optionalindex?: {
    element: (keyof S)[] | keyof S | string & {} | (string & {})[];
    name: string;
    unique: boolean;
}[]
A list of column references to generate indexes in the metadata XML of the table.
Optionallabel?: string | Documentation[]
A unique label for the table on list and form views.
name: string
Name of the table. Must be lowercase and include the application scope
schema: S
Array of column references that define the table's schema

{
    accessible_from?: never;
    accessibleFrom?: "public" | "package_private";
    allow_client_scripts?: never;
    allow_new_fields?: never;
    allow_ui_actions?: never;
    allow_web_service_access?: never;
    allowClientScripts?: boolean;
    allowNewFields?: boolean;
    allowUiActions?: boolean;
    allowWebServiceAccess?: boolean;
    auto_number?: never;
    autoNumber?: { number?: number; numberOfDigits?: number; prefix?: string };
    caller_access?: never;
    callerAccess?: "none" | "tracking" | "restricted";
    licensing_config?: never;
    licensingConfig?: LicensingConfig;
    live_feed?: never;
    liveFeed?: boolean;
    read_only?: never;
    readOnly?: boolean;
    scriptable_table?: never;
    scriptableTable?: boolean;
    text_index?: never;
    textIndex?: boolean;
}
- Optionalaccessible_from?: never
  Deprecated
  Use accessibleFrom instead
- OptionalaccessibleFrom?: "public" | "package_private"
  Application scopes that can access the table.
- Optionalallow_client_scripts?: never
  Deprecated
  Use allowClientScripts instead
- Optionalallow_new_fields?: never
  Deprecated
  Use allowNewFields instead
- Optionalallow_ui_actions?: never
  Deprecated
  Use allowUiActions instead
- Optionalallow_web_service_access?: never
  Deprecated
  Use allowWebServiceAccess instead
- OptionalallowClientScripts?: boolean
  Indicates whether to allow design time configuration of client scripts on the table from other application scopes.
- OptionalallowNewFields?: boolean
  Indicates whether to allow design time configuration of new fields on the table from other application scope.
- OptionalallowUiActions?: boolean
  Indicates whether to allow design time configuration of UI Actions on the table from other application scopes.
- OptionalallowWebServiceAccess?: boolean
  Indicates whether web services can make calls to the table.
- Optionalauto_number?: never
  Deprecated
  Use autoNumber instead
- OptionalautoNumber?: { number?: number; numberOfDigits?: number; prefix?: string }
  Auto-numbering configuration for the table.
  
  See
  https://docs.servicenow.com/csh?topicname=table-api-now-ts.html&version=latest
- Optionalcaller_access?: never
  Deprecated
  Use callerAccess instead
- OptionalcallerAccess?: "none" | "tracking" | "restricted"
  Access level for cross-scope requests.
- Optionallicensing_config?: never
  Deprecated
  Use licensingConfig instead
- OptionallicensingConfig?: LicensingConfig
  Configuration for table licensing.
- Optionallive_feed?: never
  Deprecated
  Use liveFeed instead
- OptionalliveFeed?: boolean
  Indicates if live feeds are available for records in the table.
- Optionalread_only?: never
  Deprecated
  Use readOnly instead
- OptionalreadOnly?: boolean
  Indicates whether users can edit fields in the table.
- Optionalscriptable_table?: never
  Deprecated
  use scriptableTable instead
- OptionalscriptableTable?: boolean
  Indicates whether the table is a remote table that uses data retrieved from an external source.
- Optionaltext_index?: never
  Deprecated
  Use textIndex instead
- OptionaltextIndex?: boolean
  Indicates whether search engines index the text in a table.
{
    accessible_from?: "public" | "package_private";
    accessibleFrom?: never;
    allow_client_scripts?: boolean;
    allow_new_fields?: boolean;
    allow_ui_actions?: boolean;
    allow_web_service_access?: boolean;
    allowClientScripts?: never;
    allowNewFields?: never;
    allowUiActions?: never;
    allowWebServiceAccess?: never;
    auto_number?: {
        number?: number;
        number_of_digits?: number;
        prefix?: string;
    };
    autoNumber?: never;
    caller_access?: "none"
    | "tracking"
    | "restricted";
    callerAccess?: never;
    licensing_config?: LicensingConfig;
    licensingConfig?: never;
    live_feed?: boolean;
    liveFeed?: never;
    read_only?: boolean;
    readOnly?: never;
    scriptable_table?: boolean;
    scriptableTable?: never;
    text_index?: boolean;
    textIndex?: never;
}
- Optionalaccessible_from?: "public" | "package_private"
  Deprecated
  Use accessibleFrom instead
- OptionalaccessibleFrom?: never
  Application scopes that can access the table.
- Optionalallow_client_scripts?: boolean
  Deprecated
  Use allowClientScripts instead
- Optionalallow_new_fields?: boolean
  Deprecated
  Use allowNewFields instead
- Optionalallow_ui_actions?: boolean
  Deprecated
  Use allowUiActions instead
- Optionalallow_web_service_access?: boolean
  Deprecated
  Use allowWebServiceAccess instead
- OptionalallowClientScripts?: never
  Indicates whether to allow design time configuration of client scripts on the table from other application scopes.
- OptionalallowNewFields?: never
  Indicates whether to allow design time configuration of new fields on the table from other application scope.
- OptionalallowUiActions?: never
  Indicates whether to allow design time configuration of UI Actions on the table from other application scopes.
- OptionalallowWebServiceAccess?: never
  Indicates whether web services can make calls to the table.
- Optionalauto_number?: { number?: number; number_of_digits?: number; prefix?: string }
  Deprecated
  Use autoNumber instead
- OptionalautoNumber?: never
  Auto-numbering configuration for the table.
  
  See
  https://docs.servicenow.com/csh?topicname=table-api-now-ts.html&version=latest
- Optionalcaller_access?: "none" | "tracking" | "restricted"
  Deprecated
  Use callerAccess instead
- OptionalcallerAccess?: never
  Access level for cross-scope requests.
- Optionallicensing_config?: LicensingConfig
  Deprecated
  Use licensingConfig instead
- OptionallicensingConfig?: never
  Configuration for table licensing.
- Optionallive_feed?: boolean
  Deprecated
  Use liveFeed instead
- OptionalliveFeed?: never
  Indicates if live feeds are available for records in the table.
- Optionalread_only?: boolean
  Deprecated
  Use readOnly instead
- OptionalreadOnly?: never
  Indicates whether users can edit fields in the table.
- Optionalscriptable_table?: boolean
  Deprecated
  use scriptableTable instead
- OptionalscriptableTable?: never
  Indicates whether the table is a remote table that uses data retrieved from an external source.
- Optionaltext_index?: boolean
  Deprecated
  Use textIndex instead
- OptionaltextIndex?: never
  Indicates whether search engines index the text in a table.

See

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

Param: table

an object containing the following properties:

name - name of the table. Must be lowercase and include the application scope
schema - array of column references
accessibleFrom? - application scopes that can access the table.
actions? - A list of access options
allowClientScripts? - indicates whether to allow design time configuration of client scripts on the table from other application scopes
allowNewFields? - indicates whether to allow design time configuration of new fields on the table from other application scope
allowUiActions? - indicates whether to allow design time configuration of UI actions on the table from other application scope
allowWebServiceAccess? - indicates whether web services can make calls to the table
attributes? - pairs of any supported dictionary attributes (sys_schema_attribute)
audit? - indicates whether to track the creation, update, and deletion of all records in the table
autoNumber? - auto-numbering configuration (sys_number) for a table. For more information, see auto_number object
callerAccess? - access level for cross-scope requests
display? - default display column. Use a column name from the schema property
extends? - the name of any other table on which the table is based. Extending a base table incorporates all the fields of the original table and creates system fields for the new table
extensible? - indicates whether other tables can extend the table
index? - list of column references to generate indexes in the metadata XML of the table
label? - a unique label for the table on list and form views.
liveFeed? - indicates if live feeds are available for records in the table
readOnly? - indicates whether users can edit fields in the table
textIndex? - indicates whether search engines index the text in a table

Type Alias Table<S, E>

Type Parameters

Type Declaration

Optionalactions?: ("read" | "update" | "delete" | "create")[]

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

Optionalaudit?: boolean

Optionaldisplay?: string

Optionalextends?: E

Optionalextensible?: boolean

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

Optionallabel?: string | Documentation[]

name: string

schema: S

Optionalaccessible_from?: never

Deprecated

OptionalaccessibleFrom?: "public" | "package_private"

Optionalallow_client_scripts?: never

Deprecated

Optionalallow_new_fields?: never

Deprecated

Optionalallow_ui_actions?: never

Deprecated

Optionalallow_web_service_access?: never

Deprecated

OptionalallowClientScripts?: boolean

OptionalallowNewFields?: boolean

OptionalallowUiActions?: boolean

OptionalallowWebServiceAccess?: boolean

Optionalauto_number?: never

Deprecated

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

See

Optionalcaller_access?: never

Deprecated

OptionalcallerAccess?: "none" | "tracking" | "restricted"

Optionallicensing_config?: never

Deprecated

OptionallicensingConfig?: LicensingConfig

Optionallive_feed?: never

Deprecated

OptionalliveFeed?: boolean

Optionalread_only?: never

Deprecated

OptionalreadOnly?: boolean

Optionalscriptable_table?: never

Deprecated

OptionalscriptableTable?: boolean

Optionaltext_index?: never

Deprecated

OptionaltextIndex?: boolean

Optionalaccessible_from?: "public" | "package_private"

Deprecated

OptionalaccessibleFrom?: never

Optionalallow_client_scripts?: boolean

Deprecated

Optionalallow_new_fields?: boolean

Deprecated

Optionalallow_ui_actions?: boolean

Deprecated

Optionalallow_web_service_access?: boolean

Deprecated

OptionalallowClientScripts?: never

OptionalallowNewFields?: never

OptionalallowUiActions?: never

OptionalallowWebServiceAccess?: never

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

Deprecated

OptionalautoNumber?: never

See

Optionalcaller_access?: "none" | "tracking" | "restricted"

Deprecated

OptionalcallerAccess?: never

Optionallicensing_config?: LicensingConfig

Deprecated

OptionallicensingConfig?: never

Optionallive_feed?: boolean

Deprecated

OptionalliveFeed?: never

Optionalread_only?: boolean

Deprecated

`Optional`actions?: ("read" | "update" | "delete" | "create")[]

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

`Optional`audit?: boolean

`Optional`display?: string

`Optional`extends?: E

`Optional`extensible?: boolean

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

`Optional`label?: string | Documentation[]

`Optional`accessible_from?: never

`Optional`accessibleFrom?: "public" | "package_private"

`Optional`allow_client_scripts?: never

`Optional`allow_new_fields?: never

`Optional`allow_ui_actions?: never

`Optional`allow_web_service_access?: never

`Optional`allowClientScripts?: boolean

`Optional`allowNewFields?: boolean

`Optional`allowUiActions?: boolean

`Optional`allowWebServiceAccess?: boolean

`Optional`auto_number?: never

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

`Optional`caller_access?: never

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

`Optional`licensing_config?: never

`Optional`licensingConfig?: LicensingConfig

`Optional`live_feed?: never

`Optional`liveFeed?: boolean

`Optional`read_only?: never

`Optional`readOnly?: boolean

`Optional`scriptable_table?: never

`Optional`scriptableTable?: boolean

`Optional`text_index?: never

`Optional`textIndex?: boolean

`Optional`accessible_from?: "public" | "package_private"

`Optional`accessibleFrom?: never

`Optional`allow_client_scripts?: boolean

`Optional`allow_new_fields?: boolean

`Optional`allow_ui_actions?: boolean

`Optional`allow_web_service_access?: boolean

`Optional`allowClientScripts?: never

`Optional`allowNewFields?: never

`Optional`allowUiActions?: never

`Optional`allowWebServiceAccess?: never

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

`Optional`autoNumber?: never

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

`Optional`callerAccess?: never

`Optional`licensing_config?: LicensingConfig

`Optional`licensingConfig?: never

`Optional`live_feed?: boolean

`Optional`liveFeed?: never

`Optional`read_only?: boolean

`Optional`readOnly?: never

`Optional`scriptable_table?: boolean

`Optional`scriptableTable?: never

`Optional`text_index?: boolean

`Optional`textIndex?: never