Twins - DigitalTwins GetById

Service:

Azure Digital Twins

API Version:

2023-10-31

Recupera un gemello digitale. Codici di stato:

• 200 - OK
• 400 - Richiesta non valida
  • InvalidArgument: l'ID gemello digitale non è valido.
• 404 - Non trovato
  • DigitalTwinNotFound : il gemello digitale non è stato trovato.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
id	path	True	string	ID del gemello digitale. L'ID è univoco all'interno del servizio e la distinzione tra maiuscole e minuscole.
api-version	query	True	string	Versione dell'API richiesta.

Intestazione della richiesta

Nome	Necessario	Tipo	Descrizione
traceparent		string	Identifica la richiesta in un sistema di traccia distribuita.
tracestate		string	Fornisce informazioni di identificazione di traccia specifiche del fornitore ed è un compagno di traccia.

Risposte

Nome	Tipo	Descrizione
200 OK	DigitalTwin	Operazione riuscita Headers ETag: string
Other Status Codes	ErrorResponse	Risposta predefinita. Headers x-ms-error-code: string

Sicurezza

oauth2

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

Esempio

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"
    }
  }
}

Definizioni

Nome	Descrizione
Error	Definizione di errore.
ErrorResponse	Risposta di errore.
InnerError	Descrizione dell'errore più specifica di quella fornita dall'errore contenente.

Error

Definizione di errore.

Nome	Tipo	Descrizione
code	string	Codice di errore specifico del servizio che funge da sottostatus per il codice di errore HTTP.
details	Error[]	Dettagli dell'errore interno.
innererror	InnerError	Oggetto contenente informazioni più specifiche dell'oggetto corrente sull'errore.
message	string	Rappresentazione leggibile dell'errore.

ErrorResponse

Risposta di errore.

Nome	Tipo	Descrizione
error	Error	Dettagli dell'errore.

InnerError

Descrizione dell'errore più specifica di quella fornita dall'errore contenente.

Nome	Tipo	Descrizione
code	string	Codice di errore più specifico di quello fornito dall'errore contenente.
innererror	InnerError	Oggetto contenente informazioni più specifiche dell'oggetto corrente sull'errore.