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: AuthenticationScheme | null;
    baseUrl: ValueTemplate;
    baseUrlParameter: RestParameter | null;
    documentation: string;
    excluded: boolean;
    exportLevel: ExportLevel;
    name: string;
    openApiFile: OpenApiFile | null;
    operations: RestOperation[];
}

Hierarchy (View Summary)

DocumentBase
- ConsumedRestService

Index

Properties

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

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: AuthenticationScheme | null

baseUrl

baseUrl: ValueTemplate

baseUrlParameter

baseUrlParameter: RestParameter | null

documentation

documentation: string

excluded

excluded: boolean

exportLevel

exportLevel: ExportLevel

name

name: string

openApiFile

openApiFile: OpenApiFile | null

operations

operations: RestOperation[]