Twins - DigitalTwins Update

Service:

Azure Digital Twins

API Version:

2023-10-31

Frissítések egy digitális ikerpéldányt. Állapotkódok:

• 204 Nincs tartalom
• 400 Hibás kérelem
  • InvalidArgument – A digitális ikerpéldány azonosítója vagy hasznos adata érvénytelen.
  • JsonPatchInvalid – A megadott JSON-javítás érvénytelen.
  • ValidationFailed – A javítás alkalmazása érvénytelen digitális ikerpéldányt eredményez.
• 404 Nem található
  • DigitalTwinNotFound – A digitális ikerpéldány nem található.
• 412 Az előfeltétel nem sikerült
  • PreconditionFailed – Az előfeltételek ellenőrzése (If-Match vagy If-None-Match) sikertelen volt.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
id	path	True	string	A digitális ikerpéldány azonosítója. Az azonosító egyedi a szolgáltatáson belül, és megkülönbözteti a kis- és nagybetűk megkülönböztetése.
api-version	query	True	string	A kért API-verzió.

Kérelem fejléce

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

Name	Kötelező	Típus	Description
If-Match		string	Csak akkor hajtsa végre a műveletet, ha az entitás etagje megegyezik a megadott etagek egyikével, vagy * meg van adva.
traceparent		string	Azonosítja a kérést egy elosztott nyomkövetési rendszerben.
tracestate		string	Szállítóspecifikus nyomkövetési azonosítási információkat nyújt, és a nyomkövetési adatok kísérője.

Kérelem törzse

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

Name	Típus	Description
patchDocument	object[]	A JSON-javítás által leírt frissítési specifikáció. Frissítések tulajdonságértékek és $model elemek ugyanabban a kérésben fordulhatnak elő. A műveletek hozzáadására, cseréjére és eltávolítására korlátozódnak.

Válaszok

Name	Típus	Description
204 No Content		Siker Headers ETag: string
Other Status Codes	ErrorResponse	Alapértelmezett válasz. Headers x-ms-error-code: string

Biztonság

oauth2

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

Példák

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

Definíciók

Name	Description
Error	Hibadefiníció.
ErrorResponse	Hibaválasz.
InnerError	Pontosabb hibaleírás, mint amit a hiba tartalmazott.

Error

Hibadefiníció.

Name	Típus	Description
code	string	Szolgáltatásspecifikus hibakód, amely a HTTP-hibakód alállapotaként szolgál.
details	Error[]	Belső hiba részletei.
innererror	InnerError	Egy objektum, amely az aktuális objektumnál pontosabb információkat tartalmaz a hibáról.
message	string	A hiba emberi olvasásra alkalmas ábrázolása.

ErrorResponse

Hibaválasz.

Name	Típus	Description
error	Error	A hiba részletei.

InnerError

Pontosabb hibaleírás, mint amit a hiba tartalmazott.

Name	Típus	Description
code	string	Pontosabb hibakód, mint amit a hiba tartalmazott.
innererror	InnerError	Egy objektum, amely az aktuális objektumnál pontosabb információkat tartalmaz a hibáról.