Interface ConsumedRestService

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

interface ConsumedRestService {
    $CreationOptions?: unknown;
    $ID: string;
    $Type: "Rest$ConsumedRestService";
    $UnitID?: string;
    authenticationScheme: null | AuthenticationScheme;
    baseUrl: ValueTemplate;
    baseUrlParameter: null | RestParameter;
    documentation: string;
    excluded: boolean;
    exportLevel: ExportLevel;
    name: string;
    openApiFile: null | OpenApiFile;
    operations: RestOperation[];
    addRestOperation(): Promise<RestOperation>;
    getRestOperation(name: string): undefined | RestOperation;
}

Hierarchy (View Summary)

Document
- ConsumedRestService

Index

Properties

$CreationOptions? $ID $Type $UnitID? authenticationScheme baseUrl baseUrlParameter documentation excluded exportLevel name openApiFile operations

Methods

addRestOperation getRestOperation

Properties

`Optional`$CreationOptions

$CreationOptions?: unknown

Options to pass during the element creation

$ID

$ID: string

The unique id of the element.

$Type

$Type: "Rest$ConsumedRestService"

The type of the element.

`Optional`$UnitID

$UnitID?: string

authenticationScheme

authenticationScheme: null | AuthenticationScheme

baseUrl

baseUrl: ValueTemplate

baseUrlParameter

baseUrlParameter: null | RestParameter

documentation

documentation: string

excluded

excluded: boolean

exportLevel

exportLevel: ExportLevel

name

name: string

openApiFile

openApiFile: null | OpenApiFile

operations

operations: RestOperation[]

Methods

addRestOperation

addRestOperation(): Promise<RestOperation>
Returns Promise<RestOperation>

getRestOperation

getRestOperation(name: string): undefined | RestOperation
Parameters
- name: string
Returns undefined | RestOperation