Twins - DigitalTwins Update

Service:

Azure Digital Twins

API Version:

2023-10-31

Aktualisierungen einen digitalen Zwilling. Statuscodes:

• 204 Kein Inhalt
• 400 – Ungültige Anforderung
  • InvalidArgument: Die ID oder Nutzlast des digitalen Zwillings ist ungültig.
  • JsonPatchInvalid: Der bereitgestellte JSON-Patch ist ungültig.
  • ValidationFailed: Das Anwenden des Patches führt zu einem ungültigen digitalen Zwilling.
• 404 – Nicht gefunden
  • DigitalTwinNotFound : Der digitale Zwilling wurde nicht gefunden.
• 412 Precondition Failed
  • PreconditionFailed: Fehler bei der Vorbedingungsprüfung (If-Match oder If-None-Match).

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
id	path	True	string	Die ID des digitalen Zwillings. Die ID ist innerhalb des Diensts eindeutig und beachtet die Groß-/Kleinschreibung.
api-version	query	True	string	Die angeforderte API-Version.

Anforderungsheader

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

Name	Erforderlich	Typ	Beschreibung
If-Match		string	Führen Sie den Vorgang nur aus, wenn das etag der Entität mit einem der bereitgestellten etags oder * übereinstimmt.
traceparent		string	Identifiziert die Anforderung in einem verteilten Ablaufverfolgungssystem.
tracestate		string	Stellt herstellerspezifische Ablaufverfolgungsinformationen bereit und ist ein Begleiter für traceparent.

Anforderungstext

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

Name	Typ	Beschreibung
patchDocument	object[]	Eine Updatespezifikation, die vom JSON-Patch beschrieben wird. Aktualisierungen zu Eigenschaftenwerten und $model Elementen können in derselben Anforderung erfolgen. Vorgänge sind auf das Hinzufügen, Ersetzen und Entfernen beschränkt.

Antworten

Name	Typ	Beschreibung
204 No Content		Erfolg Headers ETag: string
Other Status Codes	ErrorResponse	Standardantwort. Headers x-ms-error-code: string

Sicherheit

oauth2

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

Beispiele

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

Definitionen

Name	Beschreibung
Error	Fehlerdefinition.
ErrorResponse	Fehlerantwort.
InnerError	Eine spezifischere Fehlerbeschreibung als der enthaltende Fehler.

Error

Fehlerdefinition.

Name	Typ	Beschreibung
code	string	Dienstspezifischer Fehlercode, der als Unterstatus für den HTTP-Fehlercode dient.
details	Error[]	Interne Fehlerdetails.
innererror	InnerError	Ein Objekt, das spezifischere Informationen als das aktuelle Objekt über den Fehler enthält.
message	string	Eine für Menschen lesbare Darstellung des Fehlers.

ErrorResponse

Fehlerantwort.

Name	Typ	Beschreibung
error	Error	Die Fehlerdetails.

InnerError

Eine spezifischere Fehlerbeschreibung als der enthaltende Fehler.

Name	Typ	Beschreibung
code	string	Ein spezifischerer Fehlercode als vom enthaltenden Fehler bereitgestellt wurde.
innererror	InnerError	Ein Objekt, das spezifischere Informationen als das aktuelle Objekt über den Fehler enthält.