Twins - DigitalTwins GetById

Service:

Azure Digital Twins

API Version:

2023-10-31

Ruft einen digitalen Zwilling ab. Statuscodes:

• 200 – OK
• 400 – Ungültige Anforderung
  • InvalidArgument: Die Id des digitalen Zwillings ist ungültig.
• 404 – Nicht gefunden
  • DigitalTwinNotFound : Der digitale Zwilling wurde nicht gefunden.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
id	path	True	string	Die ID des digitalen Zwillings. Die ID ist innerhalb des Diensts eindeutig und beachtet die Groß-/Kleinschreibung.
api-version	query	True	string	Die angeforderte API-Version.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
traceparent		string	Identifiziert die Anforderung in einem verteilten Ablaufverfolgungssystem.
tracestate		string	Stellt herstellerspezifische Ablaufverfolgungsinformationen bereit und ist ein Begleiter für traceparent.

Antworten

Name	Typ	Beschreibung
200 OK	DigitalTwin	Erfolg Headers ETag: string
Other Status Codes	ErrorResponse	Standardantwort. Headers x-ms-error-code: string

Sicherheit

oauth2

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

Beispiele

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

Definitionen

Name	Beschreibung
Error	Fehlerdefinition.
ErrorResponse	Fehlerantwort.
InnerError	Eine spezifischere Fehlerbeschreibung als der enthaltende Fehler.

Error

Fehlerdefinition.

Name	Typ	Beschreibung
code	string	Dienstspezifischer Fehlercode, der als Unterstatus für den HTTP-Fehlercode dient.
details	Error[]	Interne Fehlerdetails.
innererror	InnerError	Ein Objekt, das spezifischere Informationen als das aktuelle Objekt über den Fehler enthält.
message	string	Eine für Menschen lesbare Darstellung des Fehlers.

ErrorResponse

Fehlerantwort.

Name	Typ	Beschreibung
error	Error	Die Fehlerdetails.

InnerError

Eine spezifischere Fehlerbeschreibung als der enthaltende Fehler.

Name	Typ	Beschreibung
code	string	Ein spezifischerer Fehlercode als vom enthaltenden Fehler bereitgestellt wurde.
innererror	InnerError	Ein Objekt, das spezifischere Informationen als das aktuelle Objekt über den Fehler enthält.