Options
All
  • Public
  • Public/Protected
  • All
Menu

Class PublishedRestService

See: relevant section in reference guide

In version 7.11.0: removed experimental In version 7.6.0: introduced

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

allowedRoles

allowedRoles: IList<IModuleRole>

allowedRolesQualifiedNames

allowedRolesQualifiedNames: string[]

authenticationMicroflow

authenticationMicroflow: IMicroflow | null

In version 7.17.0: introduced

authenticationMicroflowQualifiedName

authenticationMicroflowQualifiedName: string | null

authenticationType

authenticationType: RestAuthenticationType

In version 7.13.0: deleted In version 7.11.0: introduced

authenticationTypes

authenticationTypes: IList<RestAuthenticationType>

In version 7.13.0: introduced

container

container: StructuralUnit

containerAsFolderBase

containerAsFolderBase: FolderBase

containerAsModule

containerAsModule: Module

corsConfiguration

corsConfiguration: CorsConfiguration | null

In version 7.18.0: introduced

documentation

documentation: string

excluded

excluded: boolean

id

id: string

isLoaded

isLoaded: boolean

model

model: IModel

name

name: string

parameters

parameters: IList<RestOperationParameter>

In version 7.17.0: introduced

path

path: string

qualifiedName

qualifiedName: string | null

resources

resources: IList<PublishedRestServiceResource>

In version 7.7.0: introduced

serviceName

serviceName: string

In version 7.12.0: introduced

structureTypeName

structureTypeName: string

unit

unit:

version

version: string

In version 7.12.0: introduced

Static structureTypeName

structureTypeName: string

Static versionInfo

versionInfo: StructureVersionInfo

Methods

allProperties

asLoaded

  • asLoaded()

  • Transforms a IElement interface into a Element class, loading the containing unit if necessary. (Those are technically already the same, but this function makes sure its properties are available.)

    • If invoked without callback, it checks whether the properties are available or it will throw;
    • If invoked with callback, it will load the data from the server if needed, and then invoke the callback.

delete

  • delete(): void

findElementById

Protected getContainerAs

  • getContainerAs<T>(containerType: any): T

load

  • load(callback: function, forceRefresh?: boolean): void
  • load(forceRefresh?: boolean): Promise

  • Transforms a IElement interface into a Element class, loading the containing unit if necessary. (Those are technically already the same, but this function makes sure its properties are available.)

    • If invoked without callback, it checks whether the properties are available or it will throw;
    • If invoked with callback, it will load the data from the server if needed, and then invoke the callback.

    Parameters

    • callback: function
        • (elem: ): void

        • Parameters

          • elem:

          Returns void

    • Optional forceRefresh: boolean

    Returns void

  • Parameters

    • Optional forceRefresh: boolean

    Returns Promise

loadedProperties

publicProperties

toJSON

traverse

  • traverse(visit: function): void

traverseFind

  • traverseFind<T>(visit: function): T | null

traversePublicParts

  • traversePublicParts(visit: function): void

Static createIn

  • Creates a new PublishedRestService unit in the SDK and on the server. Expects one argument, the projects.IFolderBase in which this unit is contained.

    Parameters

    Returns PublishedRestService

Generated using TypeDoc