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

    Interface RestApi<I, V>

    interface RestApi<I extends number, V extends ApiVersion<I>> {
        $id: string | number | ExplicitKey<string>;
        $meta?: { installMethod?: "first install" | "demo" | "once" };
        $override?: Record<string, string | number | boolean>;
        active?: boolean;
        consumes?: string;
        doc_link?: string;
        docLink?: string;
        enforce_acl?: (string | Acl<(keyof Tables), AclType>)[];
        enforceAcl?: (string | Acl<(keyof Tables), AclType>)[];
        name: string;
        policy?: "" | "read" | "protected";
        produces?: string;
        protectionPolicy?: "" | "read" | "protected";
        routes?: (Route & { version: V["version"] })[] | Route[];
        service_id?: string;
        serviceId?: string;
        short_description?: string;
        shortDescription?: string;
        versions?: ApiVersion<I>[];
    }

    Type Parameters

    Index

    Properties

    $id $meta? $override? active? consumes? doc_link? docLink? enforce_acl? enforceAcl? name policy? produces? protectionPolicy? routes? service_id? serviceId? short_description? shortDescription? versions?

    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.

    active?: boolean

    Indicates whether the API can serve requests

    consumes?: string

    A list of media types that resources of the API can consume

    doc_link?: string

    A URL that links to static documentation about the API

    docLink?: string

    A URL that links to static documentation about the API

    enforce_acl?: (string | Acl<(keyof Tables), AclType>)[]

    A list of ACLs to enforce when accessing resources (sys_security_acl)

    enforceAcl?: (string | Acl<(keyof Tables), AclType>)[]

    A list of ACLs to enforce when accessing resources (sys_security_acl)

    name: string

    The name of the API, which is used in the API documentation.

    policy?: "" | "read" | "protected"

    Use protectionPolicy instead.

    produces?: string

    A list of media types that resources of the API can produce

    protectionPolicy?: "" | "read" | "protected"

    The policy for how application files are protected when downloaded or installed.

    routes?: (Route & { version: V["version"] })[] | Route[]

    The resources (sys_ws_operation) for the API

    service_id?: string

    The API identifier used to distinguish this API in URI paths. It must be unique within the API namespace

    serviceId?: string

    The API identifier used to distinguish this API in URI paths. It must be unique within the API namespace

    short_description?: string

    A brief description of the API, which is used in the API documentation

    shortDescription?: string

    A brief description of the API, which is used in the API documentation

    versions?: ApiVersion<I>[]

    A list of versions (sys_ws_version) for the API

    Settings

    Member Visibility

    On This Page

    Properties