Twins - DigitalTwins Update

Service:

Azure Digital Twins

API Version:

2023-10-31

Aggiornamenti un gemello digitale. Codici di stato:

• 204 No Content (Nessun contenuto)
• 400 - Richiesta non valida
  • InvalidArgument: l'ID o il payload del gemello digitale non è valido.
  • JsonPatchInvalid: la patch JSON fornita non è valida.
  • ValidationFailed: l'applicazione della patch comporta un gemello digitale non valido.
• 404 - Non trovato
  • DigitalTwinNotFound: il gemello digitale non è stato trovato.
• 412 - Condizione preliminare non riuscita
  • PrecondizioneFailed: controllo della precondizione (If-Match o If-None-Match) non riuscito.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
id	path	True	string	ID del gemello digitale. L'ID è univoco all'interno del servizio e fa distinzione tra maiuscole e minuscole.
api-version	query	True	string	Versione dell'API richiesta.

Intestazione della richiesta

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

Nome	Necessario	Tipo	Descrizione
If-Match		string	Eseguire l'operazione solo se l'etag dell'entità corrisponde a uno degli etag forniti o * .
traceparent		string	Identifica la richiesta in un sistema di traccia distribuita.
tracestate		string	Fornisce informazioni di identificazione di traccia specifiche del fornitore ed è un compagno di traccia.

Corpo della richiesta

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

Nome	Tipo	Descrizione
patchDocument	object[]	Specifica di aggiornamento descritta da JSON Patch. Aggiornamenti ai valori delle proprietà e agli elementi $model possono verificarsi nella stessa richiesta. Le operazioni sono limitate all'aggiunta, alla sostituzione e alla rimozione.

Risposte

Nome	Tipo	Descrizione
204 No Content		Operazione riuscita Headers ETag: string
Other Status Codes	ErrorResponse	Risposta predefinita. Headers x-ms-error-code: string

Sicurezza

oauth2

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

Esempio

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

Definizioni

Nome	Descrizione
Error	Definizione di errore.
ErrorResponse	Risposta di errore.
InnerError	Descrizione dell'errore più specifica di quella fornita dall'errore che lo contiene.

Error

Definizione di errore.

Nome	Tipo	Descrizione
code	string	Codice di errore specifico del servizio che funge da sottostato per il codice di errore HTTP.
details	Error[]	Dettagli dell'errore interno.
innererror	InnerError	Oggetto contenente informazioni più specifiche dell'oggetto corrente sull'errore.
message	string	Rappresentazione leggibile dell'errore.

ErrorResponse

Risposta di errore.

Nome	Tipo	Descrizione
error	Error	Dettagli dell'errore.

InnerError

Descrizione dell'errore più specifica di quella fornita dall'errore che lo contiene.

Nome	Tipo	Descrizione
code	string	Codice di errore più specifico di quello fornito dall'errore che lo contiene.
innererror	InnerError	Oggetto contenente informazioni più specifiche dell'oggetto corrente sull'errore.