Twins - DigitalTwins GetById

Service:

Azure Digital Twins

API Version:

2023-10-31

Mengambil kembar digital. Kode status:

• 200 OK
• 400 Permintaan Buruk
  • InvalidArgument - Id kembar digital tidak valid.
• 404 Tidak Ditemukan
  • DigitalTwinNotFound - Kembar digital tidak ditemukan.

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
id	path	True	string	Id kembar digital. Id unik dalam layanan dan peka huruf besar/kecil.
api-version	query	True	string	Versi API yang diminta.

Header Permintaan

Nama	Diperlukan	Jenis	Deskripsi
traceparent		string	Mengidentifikasi permintaan dalam sistem pelacakan terdistribusi.
tracestate		string	Menyediakan informasi identifikasi jejak khusus vendor dan merupakan pendamping untuk melacak.

Respons

Nama	Jenis	Deskripsi
200 OK	DigitalTwin	Berhasil Headers ETag: string
Other Status Codes	ErrorResponse	Respons default. Headers x-ms-error-code: string

Keamanan

oauth2

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

Contoh

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

Definisi

Nama	Deskripsi
Error	Definisi kesalahan.
ErrorResponse	Respons kesalahan.
InnerError	Deskripsi kesalahan yang lebih spesifik daripada yang disediakan oleh kesalahan yang berisi.

Error

Definisi kesalahan.

Nama	Jenis	Deskripsi
code	string	Kode kesalahan khusus layanan yang berfungsi sebagai substatus untuk kode kesalahan HTTP.
details	Error[]	Detail kesalahan internal.
innererror	InnerError	Objek yang berisi informasi yang lebih spesifik daripada objek saat ini tentang kesalahan.
message	string	Representasi kesalahan yang dapat dibaca manusia.

ErrorResponse

Respons kesalahan.

Nama	Jenis	Deskripsi
error	Error	Detail kesalahan.

InnerError

Deskripsi kesalahan yang lebih spesifik daripada yang disediakan oleh kesalahan yang berisi.

Nama	Jenis	Deskripsi
code	string	Kode kesalahan yang lebih spesifik daripada yang disediakan oleh kesalahan yang berisi.
innererror	InnerError	Objek yang berisi informasi yang lebih spesifik daripada objek saat ini tentang kesalahan.