Twins - DigitalTwins Update

Service:

Azure Digital Twins

API Version:

2023-10-31

更新數位對應項。 狀態碼：

• 204 沒有內容
• 400 不正確的要求
  • InvalidArgument - 數位對應項識別碼或承載無效。
  • JsonPatchInvalid - 提供的 JSON 修補程式無效。
  • ValidationFailed - 套用修補程式會導致不正確數位對應項。
• 404 找不到
  • DigitalTwinNotFound - 找不到數位對應項。
• 412 先決條件失敗
  • PreconditionFailed - 先決條件檢查 (If-Match 或 If-None-Match) 失敗。

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

URI 參數

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

要求標頭

Media Types: "application/json-patch+json"

名稱	必要	類型	Description
If-Match		string	只有在實體的 etag 符合提供的其中一個 etag 或 * 時，才執行作業。
traceparent		string	識別分散式追蹤系統中的要求。
tracestate		string	提供廠商特定的追蹤識別資訊，而且是追蹤親和的隨附專案。

要求本文

Media Types: "application/json-patch+json"

名稱	類型	Description
patchDocument	object[]	JSON 修補程式所描述的更新規格。 更新屬性值和$model元素可能會在相同的要求中發生。 作業僅限於新增、取代和移除。

回應

名稱	類型	Description
204 No Content		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

範例

Update a digital twin

Update a digital twin (multiple updates)

Update a digital twin

Sample Request

HTTP

PATCH https://digitaltwins-hostname/digitaltwins/myNewTwinId?api-version=2023-10-31

[
  {
    "op": "replace",
    "path": "/property1",
    "value": 1
  }
]

Sample Response

Status code:

204

Update a digital twin (multiple updates)

Sample Request

HTTP

PATCH https://digitaltwins-hostname/digitaltwins/myNewTwinId?api-version=2023-10-31

[
  {
    "op": "replace",
    "path": "/property1",
    "value": 1
  },
  {
    "op": "replace",
    "path": "/$metadata/property1/sourceTime",
    "value": "2022-05-31T12:00:01.000125009Z"
  },
  {
    "op": "add",
    "path": "/property2/subProperty1",
    "value": 1
  },
  {
    "op": "remove",
    "path": "/property3"
  }
]

Sample Response

Status code:

204

定義

名稱	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	物件，包含比目前物件有關錯誤的更特定資訊。