Dela via


Twins - DigitalTwins GetComponent

Hämtar en komponent från en digital tvilling. Statuskoder:

  • 200 OK
  • 400 Felaktig begäran
    • InvalidArgument – sökvägen till det digitala tvilling-ID:t eller komponenten är ogiltig.
  • 404 – Hittades inte
    • DigitalTwinNotFound – Den digitala tvillingen hittades inte.
    • ComponentNotFound – Det gick inte att hitta komponentsökvägen.
GET https://digitaltwins-hostname/digitaltwins/{id}/components/{componentPath}?api-version=2023-10-31

URI-parametrar

Name I Obligatorisk Typ Description
componentPath
path True

string

Namnet på DTDL-komponenten.

id
path True

string

ID:t för den digitala tvillingen. ID:t är unikt i tjänsten och skiftlägeskänsligt.

api-version
query True

string

Den begärda API-versionen.

Begärandehuvud

Name Obligatorisk Typ Description
traceparent

string

Identifierar begäran i ett distribuerat spårningssystem.

tracestate

string

Tillhandahåller leverantörsspecifik spårningsidentifieringsinformation och är ett komplement till spårningsparent.

Svar

Name Typ Description
200 OK

Component

Klart

Headers

ETag: string

Other Status Codes

ErrorResponse

Standardsvar.

Headers

x-ms-error-code: string

Säkerhet

oauth2

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

Exempel

Get a component in a digital twin

Sample Request

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

Sample Response

{
  "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": {
    "$lastUpdateTime": "2022-02-28T00:30:00.1234567Z",
    "property1": {
      "lastUpdateTime": "2022-02-28T00:30:00.1234567Z"
    },
    "property2": {
      "lastUpdateTime": "2022-02-28T00:30:00.1234567Z"
    }
  }
}

Definitioner

Name Description
Error

Feldefinition.

ErrorResponse

Felsvar.

InnerError

En mer specifik felbeskrivning än vad som angavs av det innehållande felet.

Error

Feldefinition.

Name Typ Description
code

string

Tjänstspecifik felkod som fungerar som understatus för HTTP-felkoden.

details

Error[]

Intern felinformation.

innererror

InnerError

Ett objekt som innehåller mer specifik information än det aktuella objektet om felet.

message

string

En läsbar återgivning av felet.

ErrorResponse

Felsvar.

Name Typ Description
error

Error

Felinformationen.

InnerError

En mer specifik felbeskrivning än vad som angavs av det innehållande felet.

Name Typ Description
code

string

En mer specifik felkod än vad som angavs av det innehållande felet.

innererror

InnerError

Ett objekt som innehåller mer specifik information än det aktuella objektet om felet.