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

    Interface ApiVersion<I>

    Version definition for a REST API (sys_ws_version).

    interface ApiVersion<I extends number = number> {
        $id: string | number | ExplicitKey<string>;
        active?: boolean;
        deprecated?: boolean;
        is_default?: boolean;
        isDefault?: boolean;
        short_description?: string;
        shortDescription?: string;
        version: I;
    }

    Type Parameters

    • I extends number = number
    Index

    Properties

    $id active? deprecated? is_default? isDefault? short_description? shortDescription? version

    Properties

    $id: string | number | ExplicitKey<string>
    active?: boolean

    Indicates whether the API version is active and can receive requests.

    deprecated?: boolean

    Indicates whether the API version is deprecated.

    is_default?: boolean

    Indicates whether this is the default version of the API.

    isDefault?: boolean

    Indicates whether this is the default version of the API.

    short_description?: string

    A brief description of the API version.

    shortDescription?: string

    A brief description of the API version.

    version: I

    The version number of the API.

    Settings

    Member Visibility

    On This Page

    Properties