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

id

id: string

structureTypeName

structureTypeName: string

Static structureTypeName

structureTypeName: string

Static versionInfo

Accessors

commit

  • In version 7.14.0: introduced

    Returns CommitEnum

  • In version 7.14.0: introduced

    Parameters

    Returns any

container

containerAsPublishedRestServiceResource

deprecated

  • get (): boolean
  • set (newValue: boolean): any
  • In version 7.15.0: introduced

    Returns boolean

  • In version 7.15.0: introduced

    Parameters

    • newValue: boolean

    Returns any

documentation

  • get (): string
  • set (newValue: string): any
  • Returns string

  • Parameters

    • newValue: string

    Returns any

exportMapping

  • In version 7.14.0: introduced

    Returns IExportMapping | null

  • In version 7.14.0: introduced

    Parameters

    Returns any

exportMappingQualifiedName

  • get (): string | null
  • Returns string | null

httpMethod

importMapping

  • In version 7.14.0: introduced

    Returns IImportMapping | null

  • In version 7.14.0: introduced

    Parameters

    Returns any

importMappingQualifiedName

  • get (): string | null
  • Returns string | null

isLoaded

  • get (): boolean
  • Checks whether all attributes are available ATM

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

    Returns boolean

microflow

microflowQualifiedName

  • get (): string | null
  • Returns string | null

model

objectHandlingBackup

parameters

path

  • get (): string
  • set (newValue: string): any
  • Returns string

  • Parameters

    • newValue: string

    Returns any

summary

  • get (): string
  • set (newValue: string): any
  • Returns string

  • Parameters

    • newValue: string

    Returns any

unit

Methods

allProperties

  • allProperties(): AbstractProperty<any, any>[]

asLoaded

  • asLoaded(): this
  • 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.

    Returns this

deepCopy

deepCopyWithIdMap

delete

  • delete(): void

detach

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

    Returns this

findElementById

Protected getContainerAs

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

load

  • load(callback: function, forceRefresh?: undefined | false | true): void
  • load(forceRefresh?: undefined | false | true): Promise<this>
  • 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: this): void
        • Parameters

          • elem: this

          Returns void

    • Optional forceRefresh: undefined | false | true

    Returns void

  • Parameters

    • Optional forceRefresh: undefined | false | true

    Returns Promise<this>

loadedProperties

  • loadedProperties(): AbstractProperty<any, any>[]

publicProperties

  • publicProperties(): AbstractProperty<any, any>[]

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