Twins - DigitalTwins GetComponent

Service:

Azure Digital Twins

API Version:

2023-10-31

Egy összetevőt kér le egy digitális ikerpéldányból. Állapotkódok:

• 200 OK
• 400 Hibás kérelem
  • InvalidArgument – A digitális ikerpéldány azonosítója vagy összetevő elérési útja érvénytelen.
• 404 Nem található
  • DigitalTwinNotFound – A digitális ikerpéldány nem található.
  • ComponentNotFound – Az összetevő elérési útja nem található.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
componentPath	path	True	string	A DTDL-összetevő neve.
id	path	True	string	A digitális ikerpéldány azonosítója. Az azonosító egyedi a szolgáltatáson belül, és megkülönbözteti a kis- és nagybetűk megkülönböztetése.
api-version	query	True	string	A kért API-verzió.

Kérelem fejléce

Name	Kötelező	Típus	Description
traceparent		string	Azonosítja a kérést egy elosztott nyomkövetési rendszerben.
tracestate		string	Szállítóspecifikus nyomkövetési azonosítási információkat nyújt, és a nyomkövetési adatok kísérője.

Válaszok

Name	Típus	Description
200 OK	Component	Siker Headers ETag: string
Other Status Codes	ErrorResponse	Alapértelmezett válasz. Headers x-ms-error-code: string

Biztonság

oauth2

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

Példák

Get a component in a digital twin

Sample Request

HTTP

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

Sample Response

Status code:

200

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

Definíciók

Name	Description
Error	Hibadefiníció.
ErrorResponse	Hibaválasz.
InnerError	Pontosabb hibaleírás, mint amit a hiba tartalmazott.

Error

Hibadefiníció.

Name	Típus	Description
code	string	Szolgáltatásspecifikus hibakód, amely a HTTP-hibakód alállapotaként szolgál.
details	Error[]	Belső hiba részletei.
innererror	InnerError	Egy objektum, amely az aktuális objektumnál pontosabb információkat tartalmaz a hibáról.
message	string	A hiba emberi olvasásra alkalmas ábrázolása.

ErrorResponse

Hibaválasz.

Name	Típus	Description
error	Error	A hiba részletei.

InnerError

Pontosabb hibaleírás, mint amit a hiba tartalmazott.

Name	Típus	Description
code	string	Pontosabb hibakód, mint amit a hiba tartalmazott.
innererror	InnerError	Egy objektum, amely az aktuális objektumnál pontosabb információkat tartalmaz a hibáról.