Twins - DigitalTwins Update

Service:

Azure Digital Twins

API Version:

2023-10-31

Mises à jour un jumeau numérique. Codes d’état :

• 204 Pas de contenu
• 400 Demande incorrecte
  • InvalidArgument : l’ID ou la charge utile du jumeau numérique n’est pas valide.
  • JsonPatchInvalid : le correctif JSON fourni n’est pas valide.
  • ValidationFailed : l’application du correctif entraîne un jumeau numérique non valide.
• 404 Introuvable
  • DigitalTwinNotFound : le jumeau numérique est introuvable.
• 412 Échec de la condition préalable
  • Condition préalable Échec : la vérification des conditions préalables (If-Match ou If-None-Match) a échoué.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
id	path	True	string	ID du jumeau numérique. L’ID est unique dans le service et respecte la casse.
api-version	query	True	string	Version de l’API demandée.

En-tête de la demande

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

Nom	Obligatoire	Type	Description
If-Match		string	Effectuez l’opération uniquement si l’etag de l’entité correspond à l’un des etags fournis ou si * est fourni.
traceparent		string	Identifie la demande dans un système de suivi distribué.
tracestate		string	Fournit des informations d’identification de trace spécifiques au fournisseur et est un compagnon de traceparent.

Corps de la demande

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

Nom	Type	Description
patchDocument	object[]	Spécification de mise à jour décrite par JSON Patch. Mises à jour aux valeurs de propriété et $model éléments peuvent se produire dans la même requête. Les opérations sont limitées à l’ajout, au remplacement et à la suppression.

Réponses

Nom	Type	Description
204 No Content		Succès Headers ETag: string
Other Status Codes	ErrorResponse	Réponse par défaut. Headers x-ms-error-code: string

Sécurité

oauth2

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

Exemples

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

Définitions

Nom	Description
Error	Définition de l’erreur.
ErrorResponse	Réponse d’erreur.
InnerError	Description d’erreur plus spécifique que celle fournie par l’erreur contenant.

Error

Définition de l’erreur.

Nom	Type	Description
code	string	Code d’erreur spécifique au service qui sert de sous-état pour le code d’erreur HTTP.
details	Error[]	Détails de l’erreur interne.
innererror	InnerError	Objet contenant des informations plus spécifiques que l’objet actuel sur l’erreur.
message	string	Représentation lisible de l’erreur.

ErrorResponse

Réponse d’erreur.

Nom	Type	Description
error	Error	Détails de l’erreur.

InnerError

Description d’erreur plus spécifique que celle fournie par l’erreur contenant.

Nom	Type	Description
code	string	Un code d’erreur plus spécifique que celui fourni par l’erreur contenant.
innererror	InnerError	Objet contenant des informations plus spécifiques que l’objet actuel sur l’erreur.