@mendix/extensions-api - v0.9.0
    Preparing search index...

    Interface RestOperation

    An element is part of a Mendix model and all elements together form the logic of the model. Elements may contain other elements. An element always has a container element, which is its parent. The root of an element tree is always a unit.

    interface RestOperation {
        $CreationOptions?: unknown;
        $ID: string;
        $Type: "Rest$RestOperation";
        $UnitID?: string;
        headers: HeaderWithValueTemplate[];
        method: RestOperationMethod;
        name: string;
        parameters: OperationParameter[];
        path: ValueTemplate;
        queryParameters: Rest.QueryParameter[];
        responseHandling: RestOperationResponseHandling;
        tags: string[];
        timeout: number;
        addHeaderWithValueTemplate(): Promise<HeaderWithValueTemplate>;
        addOperationParameter(): Promise<OperationParameter>;
        addQueryParameter(): Promise<Rest.QueryParameter>;
        delete(): void;
        getContainer(): ConsumedRestService;
        getHeaderWithValueTemplate(
            name: string,
        ): undefined | HeaderWithValueTemplate;
        getOperationParameter(name: string): undefined | OperationParameter;
        getQueryParameter(name: string): undefined | Rest.QueryParameter;
    }

    Hierarchy (View Summary)

    Index

    Properties

    $CreationOptions? $ID $Type $UnitID? headers method name parameters path queryParameters responseHandling tags timeout

    Methods

    addHeaderWithValueTemplate addOperationParameter addQueryParameter delete getContainer getHeaderWithValueTemplate getOperationParameter getQueryParameter

    Properties

    $CreationOptions?: unknown

    Options to pass during the element creation

    $ID: string

    The unique id of the element.

    $Type: "Rest$RestOperation"

    The type of the element.

    $UnitID?: string
    headers: HeaderWithValueTemplate[]
    method: RestOperationMethod
    name: string
    parameters: OperationParameter[]
    path: ValueTemplate
    queryParameters: Rest.QueryParameter[]
    responseHandling: RestOperationResponseHandling
    tags: string[]
    timeout: number

    Methods

    • Returns void

    Settings

    On This Page

    Properties
    Methods