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

    Type Alias CatalogItemBaseConfig<V>

    Base properties shared by all catalog item configurations

    type CatalogItemBaseConfig<V extends VariableTypes = VariableTypes> = {
        active?: boolean;
        availability?: "desktopOnly" | "both" | "mobileOnly";
        checkedOut?: boolean;
        description?: string;
        icon?: string;
        image?: string;
        meta?: string[];
        mobilePicture?: string;
        mobilePictureType?: "desktopPicture" | "mobilePicture" | "noPicture";
        model?: string | Record<"cmdb_model">;
        name: string;
        noSearch?: boolean;
        order?: number;
        owner?: string | Record<"sys_user">;
        picture?: string;
        roles?: (string | Role)[];
        shortDescription?: string;
        showVariableHelpOnLoad?: boolean;
        startClosed?: boolean;
        state?: State;
        variables?: V;
        version?: number;
        view?: string | Record<"sys_ui_view">;
    }

    Type Parameters

    Index

    Properties

    active? availability? checkedOut? description? icon? image? meta? mobilePicture? mobilePictureType? model? name noSearch? order? owner? picture? roles? shortDescription? showVariableHelpOnLoad? startClosed? state? variables? version? view?

    Properties

    active?: boolean

    Check box to make the item active (available to be ordered)

    true
    availability?: "desktopOnly" | "both" | "mobileOnly"

    The availability of the catalog item

    'desktopOnly'
    checkedOut?: boolean

    The checked out for the catalog item

    description?: string

    The detailed description of the catalog item

    icon?: string

    The icon for the catalog item

    image?: string

    The image for the catalog item

    meta?: string[]

    Search tags for the catalog item

    mobilePicture?: string

    The mobile picture for the catalog item

    mobilePictureType?: "desktopPicture" | "mobilePicture" | "noPicture"

    Whether to use the mobile picture type

    'desktopPicture'
    model?: string | Record<"cmdb_model">

    The model of the catalog item

    name: string

    Name to appear in the catalog. Required.

    noSearch?: boolean

    Whether to exclude this item from portal search results

    false
    order?: number

    The order of the catalog item

    0
    owner?: string | Record<"sys_user">

    The owner for the catalog item

    picture?: string

    The picture for the catalog item

    roles?: (string | Role)[]

    Roles for a catalog item

    shortDescription?: string

    A short description of the catalog item

    showVariableHelpOnLoad?: boolean

    Whether to show variable help on load

    false
    startClosed?: boolean

    Whether to start closed

    false
    state?: State

    The state for the catalog item

    variables?: V

    The variables for the catalog item

    version?: number

    The version of the catalog item

    1
    view?: string | Record<"sys_ui_view">

    The view for the catalog item

    Settings

    Member Visibility

    On This Page

    Properties