Options
All
  • Public
  • Public/Protected
  • All
Menu

Class DigitalTwinModels

Package version

Class representing a DigitalTwinModels.

Hierarchy

  • DigitalTwinModels

Index

Constructors

constructor

Methods

add

  • Uploads one or more models. When any error occurs, no models are uploaded. Status codes:

    • 201 Created
    • 400 Bad Request
      • DTDLParserError - The models provided are not valid DTDL.
      • InvalidArgument - The model id is invalid.
      • LimitExceeded - The maximum number of model ids allowed in 'dependenciesFor' has been reached.
      • ModelVersionNotSupported - The version of DTDL used is not supported.
    • 409 Conflict
      • ModelAlreadyExists - The model provided already exists.

    Parameters

    Returns Promise<DigitalTwinModelsAddResponse>

delete

  • Deletes a model. A model can only be deleted if no other models reference it. Status codes:

    • 204 No Content
    • 400 Bad Request
      • InvalidArgument - The model id is invalid.
      • MissingArgument - The model id was not provided.
    • 404 Not Found
      • ModelNotFound - The model was not found.
    • 409 Conflict
      • ModelReferencesNotDeleted - The model refers to models that are not deleted.

    Parameters

    Returns Promise<coreHttp.RestResponse>

getById

list

listNext

update

  • Updates the metadata for a model. Status codes:

    • 204 No Content
    • 400 Bad Request
      • InvalidArgument - The model id is invalid.
      • JsonPatchInvalid - The JSON Patch provided is invalid.
      • MissingArgument - The model id was not provided.
    • 404 Not Found
      • ModelNotFound - The model was not found.
    • 409 Conflict
      • ModelReferencesNotDecommissioned - The model refers to models that are not decommissioned.

    Parameters

    • id: string

      The id for the model. The id is globally unique and case sensitive.

    • updateModel: any[]

      An update specification described by JSON Patch. Only the decommissioned property can be replaced.

    • Optional options: DigitalTwinModelsUpdateOptionalParams

      The options parameters.

    Returns Promise<coreHttp.RestResponse>

Generated using TypeDoc