Options
All
  • Public
  • Public/Protected
  • All
Menu

Class PublishedRestServiceOperation

In version 7.11.0: removed experimental In version 7.7.0: introduced

Hierarchy

Implements

Index

Constructors

constructor

Properties

commit

commit: CommitEnum

In version 7.14.0: introduced

container

container: AbstractElement

containerAsPublishedRestServiceResource

containerAsPublishedRestServiceResource: PublishedRestServiceResource

deprecated

deprecated: boolean

In version 7.15.0: introduced

documentation

documentation: string

exportMapping

exportMapping: IExportMapping | null

In version 7.14.0: introduced

exportMappingQualifiedName

exportMappingQualifiedName: string | null

httpMethod

httpMethod: HttpMethod

id

id: string

importMapping

importMapping: IImportMapping | null

In version 7.14.0: introduced

importMappingQualifiedName

importMappingQualifiedName: string | null

isLoaded

isLoaded: boolean

Checks whether all attributes are available ATM

  • if false, a load is required to access these properties.

microflow

microflow: IMicroflow | null

microflowQualifiedName

microflowQualifiedName: string | null

model

model: IModel

objectHandlingBackup

objectHandlingBackup: ObjectHandlingBackupEnum

In version 7.17.0: introduced

parameters

In version 7.17.0: introduced

path

path: string

structureTypeName

structureTypeName: string

summary

summary: string

unit

unit: ModelUnit

Static structureTypeName

structureTypeName: string

Static versionInfo

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.

deepCopy

deepCopyWithIdMap

delete

  • delete(): void

detach

  • detach()
  • Detaches this element from the model, so that it can be attached in a different place.

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 create

  • Creates and returns a new PublishedRestServiceOperation instance in the SDK and on the server. Expects one argument: the IModel object the instance will "live on". After creation, assign or add this instance to a property that accepts this kind of objects.

    Parameters

    Returns PublishedRestServiceOperation

Static createIn

  • Creates and returns a new PublishedRestServiceOperation instance in the SDK and on the server. The new PublishedRestServiceOperation will be automatically stored in the 'operations' property of the parent PublishedRestServiceResource element passed as argument.

    Warning! Can only be used on models with the following Mendix meta model versions: 7.7.0 and higher

    Parameters

    Returns PublishedRestServiceOperation

Generated using TypeDoc