Sign in

v7

latestSwagger 2.02026-07-13322074.5 KB
Models

Retrieves model metadata and optionally the model definition. Status codes:

  • 200 OK
  • 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.
get/models/{id}

Path parameters

idstring required

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

Query parameters

includeModelDefinitionboolean

When true the model definition will be returned as part of the result.

api-versionstring required

The requested API version.

Response

Success

displayNameobject

A language map that contains the localized display names as specified in the model definition.

descriptionobject

A language map that contains the localized descriptions as specified in the model definition.

idstring required

The id of the model as specified in the model definition.

uploadTimestring date-time

The time the model was uploaded to the service.

decommissionedboolean

Indicates if the model is decommissioned. Decommissioned models cannot be referenced by newly created digital twins.

modelobject

The model definition.