Twins - DigitalTwins GetById

Service:

Azure Digital Twins

API Version:

2023-10-31

Récupère un jumeau numérique. Codes d’état :

• 200 OK
• 400 Demande incorrecte
  • InvalidArgument : l’ID du jumeau numérique n’est pas valide.
• 404 Introuvable
  • DigitalTwinNotFound : le jumeau numérique est introuvable.

GET https://digitaltwins-hostname/digitaltwins/{id}?api-version=2023-10-31

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
id	path	True	string	ID du jumeau numérique. L’ID est unique dans le service et respecte la casse.
api-version	query	True	string	Version de l’API demandée.

En-tête de la demande

Nom	Obligatoire	Type	Description
traceparent		string	Identifie la demande dans un système de suivi distribué.
tracestate		string	Fournit des informations d’identification de trace spécifiques au fournisseur et est un compagnon de traceparent.

Réponses

Nom	Type	Description
200 OK	DigitalTwin	Succès Headers ETag: string
Other Status Codes	ErrorResponse	Réponse par défaut. Headers x-ms-error-code: string

Sécurité

oauth2

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize?resource=0b07f429-9f4b-4714-9392-cc5e8e80c8b0

Exemples

Get a digital twin by id

Sample Request

HTTP

GET https://digitaltwins-hostname/digitaltwins/myTwinId?api-version=2023-10-31

Sample Response

Status code:

200

{
  "$dtId": "myTwinId",
  "$etag": "W/\"9c2876c2-aff0-40b3-9fba-0c6be9d020a6\"",
  "property1": 1,
  "property2": {
    "subProperty1": "some value",
    "subProperty2": "some other value"
  },
  "component1": {
    "componentProperty": "some value",
    "$metadata": {
      "$lastUpdateTime": "2022-02-28T00:30:00.1234567Z",
      "componentProperty": {
        "lastUpdateTime": "2022-02-28T00:30:00.1234567Z"
      }
    }
  },
  "$metadata": {
    "$model": "dtmi:com:example:interfaces:interfaceName;1",
    "$lastUpdateTime": "2022-02-28T00:30:00.1234567Z",
    "property1": {
      "lastUpdateTime": "2022-02-28T00:30:00.1234567Z"
    },
    "property2": {
      "lastUpdateTime": "2022-02-28T00:30:00.1234567Z"
    }
  }
}

Définitions

Nom	Description
Error	Définition de l’erreur.
ErrorResponse	Réponse d’erreur.
InnerError	Description d’erreur plus spécifique que celle fournie par l’erreur contenant.

Error

Définition de l’erreur.

Nom	Type	Description
code	string	Code d’erreur spécifique au service qui sert de sous-état pour le code d’erreur HTTP.
details	Error[]	Détails de l’erreur interne.
innererror	InnerError	Objet contenant des informations plus spécifiques que l’objet actuel sur l’erreur.
message	string	Représentation lisible de l’erreur.

ErrorResponse

Réponse d’erreur.

Nom	Type	Description
error	Error	Détails de l’erreur.

InnerError

Description d’erreur plus spécifique que celle fournie par l’erreur contenant.

Nom	Type	Description
code	string	Un code d’erreur plus spécifique que celui fourni par l’erreur contenant.
innererror	InnerError	Objet contenant des informations plus spécifiques que l’objet actuel sur l’erreur.