Twins - DigitalTwins Update

Service:

Azure Digital Twins

API Version:

2023-10-31

Aktualizace digitální dvojče. Stavové kódy:

• 204 Žádný obsah
• 400 – Chybný požadavek
  • InvalidArgument – ID digitálního dvojčete nebo datová část je neplatná.
  • JsonPatchInvalid – zadaná oprava JSON je neplatná.
  • ValidationFailed – výsledkem použití opravy je neplatné digitální dvojče.
• 404 Nenalezeno
  • DigitalTwinNotFound – digitální dvojče nebylo nalezeno.
• 412 – Předběžná podmínka se nezdařila
  • PředpokladFailed – kontrola předběžné podmínky (If-Match nebo If-None-Match) selhala.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
id	path	True	string	ID digitálního dvojčete. ID je jedinečné v rámci služby a rozlišuje velká a malá písmena.
api-version	query	True	string	Požadovaná verze rozhraní API

Hlavička požadavku

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

Name	Vyžadováno	Typ	Description
If-Match		string	Operaci proveďte pouze v případě, že se značka etag entity shoduje s jednou ze zadaných značek nebo *.
traceparent		string	Identifikuje požadavek v distribuovaném trasovacím systému.
tracestate		string	Poskytuje identifikační informace o trasování specifické pro dodavatele a je doprovodnou osobou k trasování.

Text požadavku

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

Name	Typ	Description
patchDocument	object[]	Specifikace aktualizace popsaná opravou JSON. Aktualizace k hodnotám vlastností a $model elementům může dojít ve stejném požadavku. Operace jsou omezené na přidání, nahrazení a odebrání.

Odpovědi

Name	Typ	Description
204 No Content		Success Headers ETag: string
Other Status Codes	ErrorResponse	Výchozí odpověď Headers x-ms-error-code: string

Zabezpečení

oauth2

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

Příklady

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

Definice

Name	Description
Error	Definice chyby
ErrorResponse	Odpověď na chybu.
InnerError	Konkrétnější popis chyby, než poskytla chyba obsahující chybu.

Error

Definice chyby

Name	Typ	Description
code	string	Kód chyby specifický pro službu, který slouží jako dílčí stav pro kód chyby HTTP.
details	Error[]	Podrobnosti o vnitřní chybě.
innererror	InnerError	Objekt obsahující konkrétnější informace o chybě než aktuální objekt.
message	string	Lidsky čitelná reprezentace chyby.

ErrorResponse

Odpověď na chybu.

Name	Typ	Description
error	Error	Podrobnosti o chybě

InnerError

Konkrétnější popis chyby, než poskytla chyba obsahující chybu.

Name	Typ	Description
code	string	Konkrétnější kód chyby, než byl poskytnut chybou obsahující chybu.
innererror	InnerError	Objekt obsahující konkrétnější informace o chybě než aktuální objekt.