Twins - DigitalTwins GetById

Service:

Azure Digital Twins

API Version:

2023-10-31

Načte digitální dvojče. Stavové kódy:

• 200 OK
• 400 – Chybný požadavek
  • InvalidArgument – ID digitálního dvojčete je neplatné.
• 404 Nenalezeno
  • DigitalTwinNotFound – digitální dvojče nebylo nalezeno.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
id	path	True	string	ID digitálního dvojčete. ID je jedinečné v rámci služby a rozlišuje velká a malá písmena.
api-version	query	True	string	Požadovaná verze rozhraní API

Hlavička požadavku

Name	Vyžadováno	Typ	Description
traceparent		string	Identifikuje požadavek v distribuovaném trasovacím systému.
tracestate		string	Poskytuje identifikační informace o trasování specifické pro dodavatele a je doprovodnou osobou k trasování.

Odpovědi

Name	Typ	Description
200 OK	DigitalTwin	Success Headers ETag: string
Other Status Codes	ErrorResponse	Výchozí odpověď Headers x-ms-error-code: string

Zabezpečení

oauth2

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

Příklady

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

Definice

Name	Description
Error	Definice chyby
ErrorResponse	Odpověď na chybu.
InnerError	Konkrétnější popis chyby, než poskytla chyba obsahující chybu.

Error

Definice chyby

Name	Typ	Description
code	string	Kód chyby specifický pro službu, který slouží jako dílčí stav pro kód chyby HTTP.
details	Error[]	Podrobnosti o vnitřní chybě.
innererror	InnerError	Objekt obsahující konkrétnější informace o chybě než aktuální objekt.
message	string	Lidsky čitelná reprezentace chyby.

ErrorResponse

Odpověď na chybu.

Name	Typ	Description
error	Error	Podrobnosti o chybě

InnerError

Konkrétnější popis chyby, než poskytla chyba obsahující chybu.

Name	Typ	Description
code	string	Konkrétnější kód chyby, než byl poskytnut chybou obsahující chybu.
innererror	InnerError	Objekt obsahující konkrétnější informace o chybě než aktuální objekt.