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

    Interface RouteParameter

    Parameter definition for a REST API route (sys_ws_operation).

    interface RouteParameter {
        $id: string | number | ExplicitKey<string>;
        example_value?: string;
        exampleValue?: string;
        name: string;
        required?: boolean;
        short_description?: string;
        shortDescription?: string;
    }
    Index

    Properties

    $id example_value? exampleValue? name required? short_description? shortDescription?

    Properties

    $id: string | number | ExplicitKey<string>
    example_value?: string

    An example value for the parameter.

    exampleValue?: string

    An example value for the parameter.

    name: string

    The name of the parameter.

    required?: boolean

    Indicates whether the parameter is required for the request.

    short_description?: string

    A brief description of the parameter.

    shortDescription?: string

    A brief description of the parameter.

    Settings

    Member Visibility

    On This Page

    Properties