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

    Interface SPPageRouteMap

    interface SPPageRouteMap {
        $id: string | number | ExplicitKey<string>;
        $override?: Record<string, string | number | boolean>;
        active?: boolean;
        order?: number;
        portals?: PortalRef[];
        protectionPolicy?: "read" | "protected";
        roles?: (string | Role | Record<"sys_user_role">)[];
        routeFromPage: PageRef;
        routeToPage: PageRef;
        shortDescription?: string;
    }
    Index

    Properties

    $id $override? active? order? portals? protectionPolicy? roles? routeFromPage routeToPage shortDescription?

    Properties

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

    Set properties not directly supported by this API.

    active?: boolean

    Whether this route mapping is active.

    true
    order?: number

    Evaluation priority when multiple routes match the same source page and portal. Lower values are evaluated first.

    10
    portals?: PortalRef[]

    Portals this mapping is scoped to. Omit or leave empty to apply to all portals. Accepts sys_id strings, Record<'sp_portal'> references, or ServicePortal() expressions.

    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.
    roles?: (string | Role | Record<"sys_user_role">)[]

    Roles whose members follow this route. Omit or leave empty to apply to all users. Accepts role name strings, Role() expressions, or Record<'sys_user_role'> references.

    routeFromPage: PageRef

    The source page. When a portal user navigates to this page, they are redirected to routeToPage (subject to roles and portals filters).

    routeToPage: PageRef

    The destination page the user is redirected to.

    shortDescription?: string

    Admin-facing description of what this route mapping does.

    Settings

    Member Visibility

    On This Page

    Properties