Twins - DigitalTwins Update
Updates a digital twin. Status codes:
- 204 No Content
- 400 Bad Request
- InvalidArgument - The digital twin id or payload is invalid.
- JsonPatchInvalid - The JSON Patch provided is invalid.
- ValidationFailed - Applying the patch results in an invalid digital twin.
- 404 Not Found
- DigitalTwinNotFound - The digital twin was not found.
- 412 Precondition Failed
- PreconditionFailed - The precondition check (If-Match or If-None-Match) failed.
PATCH https://digitaltwins-hostname/digitaltwins/{id}?api-version=2023-10-31
Name | In | Required | Type | Description |
---|---|---|---|---|
id
|
path | True |
string |
The id of the digital twin. The id is unique within the service and case sensitive. |
api-version
|
query | True |
string |
The requested API version. |
Media Types: "application/json-patch+json"
Name | Required | Type | Description |
---|---|---|---|
If-Match |
string |
Only perform the operation if the entity's etag matches one of the etags provided or * is provided. |
|
traceparent |
string |
Identifies the request in a distributed tracing system. |
|
tracestate |
string |
Provides vendor-specific trace identification information and is a companion to traceparent. |
Media Types: "application/json-patch+json"
Name | Type | Description |
---|---|---|
patchDocument |
object[] |
An update specification described by JSON Patch. Updates to property values and $model elements may happen in the same request. Operations are limited to add, replace and remove. |
Name | Type | Description |
---|---|---|
204 No Content |
Success Headers ETag: string |
|
Other Status Codes |
Default response. Headers x-ms-error-code: string |
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize?resource=0b07f429-9f4b-4714-9392-cc5e8e80c8b0
Sample request
PATCH https://digitaltwins-hostname/digitaltwins/myNewTwinId?api-version=2023-10-31
[
{
"op": "replace",
"path": "/property1",
"value": 1
}
]
Sample response
Sample request
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
Name | Description |
---|---|
Error |
Error definition. |
Error |
Error response. |
Inner |
A more specific error description than was provided by the containing error. |
Error definition.
Name | Type | Description |
---|---|---|
code |
string |
Service specific error code which serves as the substatus for the HTTP error code. |
details |
Error[] |
Internal error details. |
innererror |
An object containing more specific information than the current object about the error. |
|
message |
string |
A human-readable representation of the error. |
Error response.
Name | Type | Description |
---|---|---|
error |
The error details. |
A more specific error description than was provided by the containing error.
Name | Type | Description |
---|---|---|
code |
string |
A more specific error code than was provided by the containing error. |
innererror |
An object containing more specific information than the current object about the error. |