Twins - DigitalTwins GetById

Service:

Azure Digital Twins

API Version:

2023-10-31

Pobiera cyfrową reprezentację bliźniaczą. Kody stanu:

• 200 OK
• 400 Nieprawidłowe żądanie
  • InvalidArgument — identyfikator cyfrowej reprezentacji bliźniaczej jest nieprawidłowy.
• 404 — Nie znaleziono
  • DigitalTwinNotFound — nie odnaleziono cyfrowej reprezentacji bliźniaczej.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
id	path	True	string	Identyfikator cyfrowej reprezentacji bliźniaczej. Identyfikator jest unikatowy w usłudze i uwzględnia wielkość liter.
api-version	query	True	string	Żądana wersja interfejsu API.

Nagłówek żądania

Nazwa	Wymagane	Typ	Opis
traceparent		string	Identyfikuje żądanie w rozproszonym systemie śledzenia.
tracestate		string	Udostępnia informacje dotyczące identyfikacji śledzenia specyficzne dla dostawcy i jest towarzyszem śledzenia.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	DigitalTwin	Powodzenie Headers ETag: string
Other Status Codes	ErrorResponse	Domyślna odpowiedź. Headers x-ms-error-code: string

Zabezpieczenia

oauth2

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

Przykłady

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

Definicje

Nazwa	Opis
Error	Definicja błędu.
ErrorResponse	Odpowiedź na błąd.
InnerError	Bardziej szczegółowy opis błędu niż został podany przez błąd zawierający.

Error

Definicja błędu.

Nazwa	Typ	Opis
code	string	Kod błędu specyficzny dla usługi, który służy jako podstatu dla kodu błędu HTTP.
details	Error[]	Szczegóły błędu wewnętrznego.
innererror	InnerError	Obiekt zawierający bardziej szczegółowe informacje niż bieżący obiekt o błędzie.
message	string	Czytelna dla człowieka reprezentacja błędu.

ErrorResponse

Odpowiedź na błąd.

Nazwa	Typ	Opis
error	Error	Szczegóły błędu.

InnerError

Bardziej szczegółowy opis błędu niż został podany przez błąd zawierający.

Nazwa	Typ	Opis
code	string	Bardziej szczegółowy kod błędu niż został dostarczony przez błąd zawierający.
innererror	InnerError	Obiekt zawierający bardziej szczegółowe informacje niż bieżący obiekt o błędzie.