Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RestOperationParameter

In version 7.11.0: removed experimental In version 7.8.0: introduced

Hierarchy

Implements

Index

Constructors

constructor

Properties

container

container: AbstractElement

containerAsPublishedRestService

containerAsPublishedRestService: PublishedRestService

containerAsPublishedRestServiceOperation

containerAsPublishedRestServiceOperation: PublishedRestServiceOperation

dataType

dataType: string

The value of this property is conceptually of type dataTypes.LegacyDataType.

In version 7.9.0: deleted

id

id: string

isLoaded

isLoaded: boolean

Checks whether all attributes are available ATM

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

microflowParameter

microflowParameter: IMicroflowParameter | null

In version 7.17.0: introduced

microflowParameterQualifiedName

microflowParameterQualifiedName: string | null

model

model: IModel

name

name: string

parameterType

structureTypeName

structureTypeName: string

type

type: DataType

In version 7.17.0: introduced

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 RestOperationParameter 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 RestOperationParameter

Static createInPublishedRestServiceOperationUnderParameters

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

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

    Parameters

    Returns RestOperationParameter

Static createInPublishedRestServiceUnderParameters

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

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

    Parameters

    Returns RestOperationParameter

Generated using TypeDoc