Twins - DigitalTwins UpdateComponent

Service:

Azure Digital Twins

API Version:

2023-10-31

デジタル ツインのコンポーネントを更新します。 状態コード:

• 204 No Content
• 400 Bad Request
  • InvalidArgument - デジタル ツイン ID、コンポーネント パス、またはペイロードが無効です。
  • JsonPatchInvalid - 指定された JSON パッチが無効です。
  • ValidationFailed - パッチを適用すると、無効なデジタル ツインが発生します。
• 404 見つかりません
  • DigitalTwinNotFound - デジタル ツインが見つかりませんでした。
• 412 Precondition Failed
  • PreconditionFailed - 前提条件チェック (If-Match または If-None-Match) が失敗しました。

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

URI パラメーター

名前	/	必須	型	説明
componentPath	path	True	string	DTDL コンポーネントの名前。
id	path	True	string	デジタル ツインの ID。 ID はサービス内で一意であり、大文字と小文字が区別されます。
api-version	query	True	string	要求された API バージョン。

要求ヘッダー

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

名前	必須	型	説明
If-Match		string	エンティティの etag が、指定された etag の 1 つと一致する場合、または * が指定されている場合にのみ、操作を実行します。
traceparent		string	分散トレース システム内の要求を識別します。
tracestate		string	ベンダー固有のトレース識別情報を提供し、traceparent に対応しています。

要求本文

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

名前	型	説明
patchDocument	object[]	JSON Patch で説明されている更新プログラムの仕様。 プロパティ値と$model要素への更新は、同じ要求で発生する可能性があります。 操作は、追加、置換、および削除に制限されます。

応答

名前	型	説明
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 component in a digital twin

Update a component in a digital twin (multiple updates)

Update a component in a digital twin

Sample Request

HTTP

PATCH https://digitaltwins-hostname/digitaltwins/myTwinId/components/myComponent?api-version=2023-10-31

[
  {
    "op": "add",
    "path": "/property",
    "value": 1
  }
]

Sample Response

Status code:

204

Update a component in a digital twin (multiple updates)

Sample Request

HTTP

PATCH https://digitaltwins-hostname/digitaltwins/myTwinId/components/myComponent?api-version=2023-10-31

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

Sample Response

Status code:

204

定義

名前	説明
Error	エラー定義。
ErrorResponse	エラー応答。
InnerError	含まれているエラーによって提供されたよりも具体的なエラーの説明。

Error

エラー定義。

名前	型	説明
code	string	HTTP エラー コードのサブステータスとして機能するサービス固有のエラー コード。
details	Error[]	内部エラーの詳細。
innererror	InnerError	エラーに関する現在のオブジェクトよりも具体的な情報を含む オブジェクト。
message	string	エラーの人間が判読できる表現。

ErrorResponse

エラー応答。

名前	型	説明
error	Error	エラーの詳細です。

InnerError

含まれているエラーによって提供されたよりも具体的なエラーの説明。

名前	型	説明
code	string	含まれているエラーによって提供されたよりも具体的なエラー コード。
innererror	InnerError	エラーに関する現在のオブジェクトよりも具体的な情報を含む オブジェクト。