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

    Interface PublishedRestService

    A unit is a container of elements, it can not contain other units.

    interface PublishedRestService {
        $CreationOptions?: unknown;
        $ID: string;
        $Type: "Rest$PublishedRestService";
        $UnitID?: string;
        allowedRoles: string[];
        authenticationMicroflow: null | string;
        authenticationTypes: RestAuthenticationType[];
        corsConfiguration: null | CorsConfiguration;
        documentation: string;
        excluded: boolean;
        exportLevel: ExportLevel;
        name: string;
        parameters: RestOperationParameter[];
        path: string;
        publicDocumentation: string;
        resources: PublishedRestServiceResource[];
        serviceName: string;
        version: string;
        addPublishedRestServiceResource(): Promise<PublishedRestServiceResource>;
        addRestOperationParameter(): Promise<RestOperationParameter>;
        getPublishedRestServiceResource(
            name: string,
        ): undefined | PublishedRestServiceResource;
        getRestOperationParameter(name: string): undefined | RestOperationParameter;
    }

    Hierarchy (View Summary)

    Index

    Properties

    $CreationOptions? $ID $Type $UnitID? allowedRoles authenticationMicroflow authenticationTypes corsConfiguration documentation excluded exportLevel name parameters path publicDocumentation resources serviceName version

    Methods

    addPublishedRestServiceResource addRestOperationParameter getPublishedRestServiceResource getRestOperationParameter

    Properties

    $CreationOptions?: unknown

    Options to pass during the element creation

    $ID: string

    The unique id of the element.

    $Type: "Rest$PublishedRestService"

    The type of the element.

    $UnitID?: string
    allowedRoles: string[]
    authenticationMicroflow: null | string
    authenticationTypes: RestAuthenticationType[]
    corsConfiguration: null | CorsConfiguration
    documentation: string
    excluded: boolean
    exportLevel: ExportLevel
    name: string
    parameters: RestOperationParameter[]
    path: string
    publicDocumentation: string
    resources: PublishedRestServiceResource[]
    serviceName: string
    version: string

    Methods

    Settings

    On This Page

    Properties
    Methods