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

    Interface Alias

    interface Alias {
        $id: string | number | ExplicitKey<string>;
        $meta?: { installMethod?: "first install" | "demo" | "once" };
        $override?: Record<string, string | number | boolean>;
        configurationTemplate?:
            | string
            | Record<"sys_alias_templates">
            | AliasTemplate;
        connectionType?: ConnectionType;
        description?: string;
        multipleConnections?: boolean;
        name: string;
        parent?: string | Alias | Record<"sys_alias">;
        protectionPolicy?: "read" | "protected";
        retryPolicy?: string | Record<"sys_retry_policy"> | RetryPolicy;
        type?: AliasType;
    }
    Index

    Properties

    $id $meta? $override? configurationTemplate? connectionType? description? multipleConnections? name parent? protectionPolicy? retryPolicy? type?

    Properties

    $id: string | number | ExplicitKey<string>
    $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.

    configurationTemplate?: string | Record<"sys_alias_templates"> | AliasTemplate

    Configuration template reference — pass the template's sys_id, or a Record<'sys_alias_templates'> reference produced by AliasTemplate.

    connectionType?: ConnectionType

    The connection type. Only applicable when type is 'connection'. Defaults to 'httpConnection'.

    description?: string

    A description of the alias.

    multipleConnections?: boolean

    Whether the alias supports multiple active connections. Defaults to false.

    name: string

    Display name for the Connection & Credential Alias.

    parent?: string | Alias | Record<"sys_alias">

    Parent alias reference. Used for child aliases that inherit from a parent.

    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.
    retryPolicy?: string | Record<"sys_retry_policy"> | RetryPolicy

    Default retry policy reference.

    type?: AliasType

    The type of alias: 'connection' (Connection and Credential) or 'credential' (Credential only). Defaults to 'connection'.

    Settings

    Member Visibility

    On This Page

    Properties