Twins - DigitalTwins GetById

Service:

Azure Digital Twins

API Version:

2023-10-31

디지털 트윈을 검색합니다. 상태 코드:

• 200 정상
• 400 잘못된 요청
  • InvalidArgument - 디지털 트윈 ID가 잘못되었습니다.
• 404 찾을 수 없음
  • DigitalTwinNotFound - 디지털 트윈을 찾을 수 없습니다.

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

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
id	path	True	string	디지털 트윈의 ID입니다. ID는 서비스 내에서 고유하며 대/소문자를 구분합니다.
api-version	query	True	string	요청된 API 버전입니다.

요청 헤더

Name	필수	형식	Description
traceparent		string	분산 추적 시스템에서 요청을 식별합니다.
tracestate		string	공급업체별 추적 식별 정보를 제공하며 추적 매개 변수의 도우미입니다.

응답

Name	형식	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"
    }
  }
}

정의

Name	Description
Error	오류 정의.
ErrorResponse	오류 응답입니다.
InnerError	포함된 오류에서 제공한 것보다 더 구체적인 오류 설명입니다.

Error

오류 정의.

Name	형식	Description
code	string	HTTP 오류 코드의 하위 상태 역할을 하는 서비스별 오류 코드입니다.
details	Error[]	내부 오류 세부 정보입니다.
innererror	InnerError	오류에 대한 현재 개체보다 더 구체적인 정보를 포함하는 개체입니다.
message	string	사람이 읽을 수 있는 오류 표현입니다.

ErrorResponse

오류 응답입니다.

Name	형식	Description
error	Error	오류 세부 정보입니다.

InnerError

포함된 오류에서 제공한 것보다 더 구체적인 오류 설명입니다.

Name	형식	Description
code	string	포함된 오류에서 제공한 것보다 더 구체적인 오류 코드입니다.
innererror	InnerError	오류에 대한 현재 개체보다 더 구체적인 정보를 포함하는 개체입니다.