Twins - DigitalTwins GetById

Service:

Azure Digital Twins

API Version:

2023-10-31

擷取數位對應項。 狀態碼：

• 200 確定
• 400 不正確的要求
  • InvalidArgument - 數位對應項識別碼無效。
• 404 找不到
  • DigitalTwinNotFound - 找不到數位對應項。

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

URI 參數

名稱	位於	必要	類型	Description
id	path	True	string	數位對應項的識別碼。 識別碼在服務內是唯一的，而且區分大小寫。
api-version	query	True	string	要求的 API 版本。

要求標頭

名稱	必要	類型	Description
traceparent		string	識別分散式追蹤系統中的要求。
tracestate		string	提供廠商特定的追蹤識別資訊，而且是追蹤親和項的隨附專案。

回應

名稱	類型	Description
200 OK	DigitalTwin	Success Headers ETag: string
Other Status Codes	ErrorResponse	預設回應。 Headers x-ms-error-code: string

安全性

oauth2

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

範例

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

定義

名稱	Description
Error	錯誤定義。
ErrorResponse	錯誤回應。
InnerError	比包含的錯誤所提供更明確的錯誤描述。

Error

錯誤定義。

名稱	類型	Description
code	string	服務特定的錯誤碼，可作為 HTTP 錯誤碼的子狀態。
details	Error[]	內部錯誤詳細資料。
innererror	InnerError	物件，包含比目前物件有關錯誤更具體的資訊。
message	string	人類可讀取的錯誤標記法。

ErrorResponse

錯誤回應。

名稱	類型	Description
error	Error	錯誤詳細資料。

InnerError

比包含的錯誤所提供更明確的錯誤描述。

名稱	類型	Description
code	string	比包含的錯誤所提供更明確的錯誤碼。
innererror	InnerError	物件，包含比目前物件有關錯誤更具體的資訊。