@servicenow/sdk - v4.4.1
    Preparing search index...
    interface pa_dashboards {
        breakdown_source: Typed<
            | string
            | Record<"pa_dimensions">
            | ExplicitKey<"pa_dimensions">
            | TableBrand<"pa_dimensions">,
            {
                attributes: { encode_utf8: false };
                label: "Breakdown source";
                referenceTable: "pa_dimensions";
            },
        >;
        color: Typed<
            string,
            {
                label: [
                    {
                        hint: "Dashboard Background Color";
                        label: "Color";
                        language: "en";
                        plural: "Colors";
                    },
                ];
                maxLength: 7;
            },
        >;
        disable_multiple_element: Typed<
            boolean,
            {
                default: false;
                label: [
                    {
                        hint: "When selected, you can filter the breakdown dashboard on only one breakdown element at a time. When cleared, you can filter the dashboard on multiple breakdown elements.";
                        label: "Disable multiple element selection";
                        language: "en";
                        plural: "Disable multiple element selections";
                    },
                ];
            },
        >;
        experience_dashboard: Typed<
            | string
            | Record<"par_dashboard">
            | ExplicitKey<"par_dashboard">
            | TableBrand<"par_dashboard">,
            {
                attributes: { encode_utf8: false };
                label: "Experience dashboard";
                readOnly: true;
                readOnlyOption: "instance_configured";
                referenceTable: "par_dashboard";
            },
        >;
        group: Typed<
            | string
            | Record<"pa_dashboards_group">
            | ExplicitKey<"pa_dashboards_group">
            | TableBrand<"pa_dashboards_group">,
            {
                attributes: { encode_utf8: false };
                label: "Group";
                referenceTable: "pa_dashboards_group";
            },
        >;
        groups: Typed<
            string
            | string[]
            | Record<"sys_user_group">[],
            {
                attributes: { no_sort: true; slushbucket_ref_no_expand: true };
                label: "Groups";
                maxLength: 1024;
                referenceTable: "sys_user_group";
            },
        >;
        is_breakdown: Typed<
            boolean,
            {
                default: false;
                label: [
                    {
                        hint: "A breakdown dashboard can be used to set the widgets on the dashboard in the context of a specified breakdown. For example see all scores around New, Open & Closed Incidents, Problems and Changes from the perspective of a specific assignment group.";
                        label: "Breakdown Source dashboard";
                        language: "en";
                        plural: "Breakdown Source dashboards";
                        url: "http://docs.servicenow.com/?context=Creating_Dashboards_Breakdown_Dashboards";
                        urlTarget: "_blank";
                    },
                ];
            },
        >;
        managed_breakdown: Typed<
            | string
            | Record<"pa_breakdowns">
            | ExplicitKey<"pa_breakdowns">
            | TableBrand<"pa_breakdowns">,
            {
                attributes: { encode_utf8: false };
                label: "Managed breakdown";
                referenceQual: "javascript:new PAUtils().ref_qual_managed_breakdown()";
                referenceTable: "pa_breakdowns";
            },
        >;
        managed_publisher: Typed<
            | string
            | Record<"sys_ui_hp_publisher">
            | ExplicitKey<"sys_ui_hp_publisher">
            | TableBrand<"sys_ui_hp_publisher">,
            { label: "Act as filter"; referenceTable: "sys_ui_hp_publisher" },
        >;
        no_bulk_migration: Typed<
            boolean,
            { default: false; label: "Do not migrate in bulk" },
        >;
        no_tabs: Typed<boolean, { default: false; label: "No tabs" }>;
        notification_link_label: Typed<
            string,
            {
                label: [
                    {
                        hint: "The link's text for the dashboard notification. Must be used with Notification Text";
                        label: "Notification Link Label";
                        language: "en";
                        plural: "Notification Link Labels";
                    },
                ];
                maxLength: 50;
            },
        >;
        notification_link_url: Typed<
            string,
            {
                label: [
                    {
                        hint: "The link's URL for the dashboard notification. Must be used with Notification Text";
                        label: "Notification Link URL";
                        language: "en";
                        plural: "Notification Link URLs";
                    },
                ];
                maxLength: 256;
            },
        >;
        notification_text: Typed<
            string,
            {
                label: [
                    {
                        hint: "Displays a notification on the dashboard with an optional link";
                        label: "Notification Text";
                        language: "en";
                        plural: "Notification Texts";
                    },
                ];
                maxLength: 200;
            },
        >;
        order: Typed<number, { label: "Order" }>;
        owner: Typed<
            | string
            | Record<"sys_user">
            | ExplicitKey<"sys_user">
            | TableBrand<"sys_user">,
            {
                default: "javascript:gs.getUserID();";
                label: "Owner";
                mandatory: true;
                referenceTable: "sys_user";
            },
        >;
        restrict_to_roles: Typed<(string | Role)[], { array: true }>;
        role_override: Typed<
            boolean,
            { default: true; label: "Visible by all roles" },
        >;
        roles: Typed<
            (string | Role)[],
            {
                array: true;
                attributes: { no_truncate: true };
                label: "Requires Roles";
            },
        >;
        should_migrate_permissions: Typed<
            boolean,
            { default: false; label: "Should migrate permissions" },
        >;
        sys_id: Typed<
            string,
            {
                label: [{ label: "Sys ID"; language: "en"; plural: "Sys IDs" }];
                primary: true;
            },
        >;
        users: Typed<
            string
            | string[]
            | Record<"sys_user">[],
            {
                attributes: { no_sort: true; slushbucket_ref_no_expand: true };
                label: "Users";
                maxLength: 1024;
                referenceTable: "sys_user";
            },
        >;
        visible_to: Typed<
            number,
            { default: "2"; dropdown: "dropdown_without_none"; label: "Visible to" },
        >;
    }

    Hierarchy (View Summary)

    Index

    Properties

    breakdown_source: Typed<
        | string
        | Record<"pa_dimensions">
        | ExplicitKey<"pa_dimensions">
        | TableBrand<"pa_dimensions">,
        {
            attributes: { encode_utf8: false };
            label: "Breakdown source";
            referenceTable: "pa_dimensions";
        },
    >
    color: Typed<
        string,
        {
            label: [
                {
                    hint: "Dashboard Background Color";
                    label: "Color";
                    language: "en";
                    plural: "Colors";
                },
            ];
            maxLength: 7;
        },
    >
    disable_multiple_element: Typed<
        boolean,
        {
            default: false;
            label: [
                {
                    hint: "When selected, you can filter the breakdown dashboard on only one breakdown element at a time. When cleared, you can filter the dashboard on multiple breakdown elements.";
                    label: "Disable multiple element selection";
                    language: "en";
                    plural: "Disable multiple element selections";
                },
            ];
        },
    >
    experience_dashboard: Typed<
        | string
        | Record<"par_dashboard">
        | ExplicitKey<"par_dashboard">
        | TableBrand<"par_dashboard">,
        {
            attributes: { encode_utf8: false };
            label: "Experience dashboard";
            readOnly: true;
            readOnlyOption: "instance_configured";
            referenceTable: "par_dashboard";
        },
    >
    group: Typed<
        | string
        | Record<"pa_dashboards_group">
        | ExplicitKey<"pa_dashboards_group">
        | TableBrand<"pa_dashboards_group">,
        {
            attributes: { encode_utf8: false };
            label: "Group";
            referenceTable: "pa_dashboards_group";
        },
    >
    groups: Typed<
        string
        | string[]
        | Record<"sys_user_group">[],
        {
            attributes: { no_sort: true; slushbucket_ref_no_expand: true };
            label: "Groups";
            maxLength: 1024;
            referenceTable: "sys_user_group";
        },
    >
    is_breakdown: Typed<
        boolean,
        {
            default: false;
            label: [
                {
                    hint: "A breakdown dashboard can be used to set the widgets on the dashboard in the context of a specified breakdown. For example see all scores around New, Open & Closed Incidents, Problems and Changes from the perspective of a specific assignment group.";
                    label: "Breakdown Source dashboard";
                    language: "en";
                    plural: "Breakdown Source dashboards";
                    url: "http://docs.servicenow.com/?context=Creating_Dashboards_Breakdown_Dashboards";
                    urlTarget: "_blank";
                },
            ];
        },
    >
    managed_breakdown: Typed<
        | string
        | Record<"pa_breakdowns">
        | ExplicitKey<"pa_breakdowns">
        | TableBrand<"pa_breakdowns">,
        {
            attributes: { encode_utf8: false };
            label: "Managed breakdown";
            referenceQual: "javascript:new PAUtils().ref_qual_managed_breakdown()";
            referenceTable: "pa_breakdowns";
        },
    >
    managed_publisher: Typed<
        | string
        | Record<"sys_ui_hp_publisher">
        | ExplicitKey<"sys_ui_hp_publisher">
        | TableBrand<"sys_ui_hp_publisher">,
        { label: "Act as filter"; referenceTable: "sys_ui_hp_publisher" },
    >
    no_bulk_migration: Typed<
        boolean,
        { default: false; label: "Do not migrate in bulk" },
    >
    no_tabs: Typed<boolean, { default: false; label: "No tabs" }>
    notification_link_label: Typed<
        string,
        {
            label: [
                {
                    hint: "The link's text for the dashboard notification. Must be used with Notification Text";
                    label: "Notification Link Label";
                    language: "en";
                    plural: "Notification Link Labels";
                },
            ];
            maxLength: 50;
        },
    >
    notification_link_url: Typed<
        string,
        {
            label: [
                {
                    hint: "The link's URL for the dashboard notification. Must be used with Notification Text";
                    label: "Notification Link URL";
                    language: "en";
                    plural: "Notification Link URLs";
                },
            ];
            maxLength: 256;
        },
    >
    notification_text: Typed<
        string,
        {
            label: [
                {
                    hint: "Displays a notification on the dashboard with an optional link";
                    label: "Notification Text";
                    language: "en";
                    plural: "Notification Texts";
                },
            ];
            maxLength: 200;
        },
    >
    order: Typed<number, { label: "Order" }>
    owner: Typed<
        | string
        | Record<"sys_user">
        | ExplicitKey<"sys_user">
        | TableBrand<"sys_user">,
        {
            default: "javascript:gs.getUserID();";
            label: "Owner";
            mandatory: true;
            referenceTable: "sys_user";
        },
    >
    restrict_to_roles: Typed<(string | Role)[], { array: true }>
    role_override: Typed<boolean, { default: true; label: "Visible by all roles" }>
    roles: Typed<
        (string | Role)[],
        { array: true; attributes: { no_truncate: true }; label: "Requires Roles" },
    >
    should_migrate_permissions: Typed<
        boolean,
        { default: false; label: "Should migrate permissions" },
    >
    sys_id: Typed<
        string,
        {
            label: [{ label: "Sys ID"; language: "en"; plural: "Sys IDs" }];
            primary: true;
        },
    >
    users: Typed<
        string
        | string[]
        | Record<"sys_user">[],
        {
            attributes: { no_sort: true; slushbucket_ref_no_expand: true };
            label: "Users";
            maxLength: 1024;
            referenceTable: "sys_user";
        },
    >
    visible_to: Typed<
        number,
        { default: "2"; dropdown: "dropdown_without_none"; label: "Visible to" },
    >