Twins - DigitalTwins GetById

Service:

Azure Digital Twins

API Version:

2023-10-31

Hiermee haalt u een digitale dubbel op. Statuscodes:

• 200 OK
• 400 Ongeldige aanvraag
  • InvalidArgument: de id van de digitale dubbel is ongeldig.
• 404 Niet gevonden
  • DigitalTwinNotFound - De digitale dubbel is niet gevonden.

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

URI-parameters

Name	In	Vereist	Type	Description
id	path	True	string	De id van de digitale dubbel. De id is uniek binnen de service en hoofdlettergevoelig.
api-version	query	True	string	De aangevraagde API-versie.

Aanvraagkoptekst

Name	Vereist	Type	Description
traceparent		string	Identificeert de aanvraag in een gedistribueerd traceringssysteem.
tracestate		string	Biedt leverancierspecifieke traceringsidentificatie-informatie en is een aanvulling op traceerouder.

Antwoorden

Name	Type	Description
200 OK	DigitalTwin	Geslaagd Headers ETag: string
Other Status Codes	ErrorResponse	Standaardantwoord. Headers x-ms-error-code: string

Beveiliging

oauth2

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

Voorbeelden

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

Definities

Name	Description
Error	Foutdefinitie.
ErrorResponse	Foutreactie.
InnerError	Een specifiekere foutbeschrijving dan is opgegeven door de betreffende fout.

Error

Foutdefinitie.

Name	Type	Description
code	string	Servicespecifieke foutcode die fungeert als de substatus voor de HTTP-foutcode.
details	Error[]	Details van interne fouten.
innererror	InnerError	Een object met specifiekere informatie dan het huidige object over de fout.
message	string	Een door mensen leesbare weergave van de fout.

ErrorResponse

Foutreactie.

Name	Type	Description
error	Error	De foutdetails.

InnerError

Een specifiekere foutbeschrijving dan is opgegeven door de betreffende fout.

Name	Type	Description
code	string	Een specifiekere foutcode dan is opgegeven door de betreffende fout.
innererror	InnerError	Een object met specifiekere informatie dan het huidige object over de fout.