Dela via


Twins - DigitalTwins UpdateComponent

Uppdateringar en komponent på en digital tvilling. Statuskoder:

  • 204 Inget innehåll
  • 400 Felaktig begäran
    • InvalidArgument – ID:t för den digitala tvillingen, komponentsökvägen eller nyttolasten är ogiltig.
    • JsonPatchInvalid – JSON-korrigeringen är ogiltig.
    • ValidationFailed – Om korrigeringen tillämpas resulterar det i en ogiltig digital tvilling.
  • 404 – Hittades inte
    • DigitalTwinNotFound – Den digitala tvillingen hittades inte.
  • 412 Förhandsvillkoret misslyckades
    • PreconditionFailed – Förhandsvillkorskontrollen (If-Match eller If-None-Match) misslyckades.
PATCH https://digitaltwins-hostname/digitaltwins/{id}/components/{componentPath}?api-version=2023-10-31

URI-parametrar

Name I Obligatorisk Typ Description
componentPath
path True

string

Namnet på DTDL-komponenten.

id
path True

string

ID:t för den digitala tvillingen. ID:t är unikt i tjänsten och skiftlägeskänsligt.

api-version
query True

string

Den begärda API-versionen.

Begärandehuvud

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

Name Obligatorisk Typ Description
If-Match

string

Utför endast åtgärden om entitetens etag matchar en av de angivna etags eller * tillhandahålls.

traceparent

string

Identifierar begäran i ett distribuerat spårningssystem.

tracestate

string

Tillhandahåller leverantörsspecifik spårningsidentifieringsinformation och är ett komplement till spårningsparent.

Begärandetext

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

Name Typ Description
patchDocument

object[]

En uppdateringsspecifikation som beskrivs av JSON Patch. Uppdateringar till egenskapsvärden och $model element kan inträffa i samma begäran. Åtgärderna är begränsade till att lägga till, ersätta och ta bort.

Svar

Name Typ Description
204 No Content

Klart

Headers

ETag: string

Other Status Codes

ErrorResponse

Standardsvar.

Headers

x-ms-error-code: string

Säkerhet

oauth2

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

Exempel

Update a component in a digital twin
Update a component in a digital twin (multiple updates)

Update a component in a digital twin

Sample Request

PATCH https://digitaltwins-hostname/digitaltwins/myTwinId/components/myComponent?api-version=2023-10-31

[
  {
    "op": "add",
    "path": "/property",
    "value": 1
  }
]

Sample Response

Update a component in a digital twin (multiple updates)

Sample Request

PATCH https://digitaltwins-hostname/digitaltwins/myTwinId/components/myComponent?api-version=2023-10-31

[
  {
    "op": "add",
    "path": "/property1",
    "value": 1
  },
  {
    "op": "replace",
    "path": "/$metadata/property1/sourceTime",
    "value": "2022-05-31T12:00:01.000125009Z"
  },
  {
    "op": "remove",
    "path": "/property2"
  },
  {
    "op": "replace",
    "path": "/property3/subProperty1",
    "value": "new value"
  }
]

Sample Response

Definitioner

Name Description
Error

Feldefinition.

ErrorResponse

Felsvar.

InnerError

En mer specifik felbeskrivning än vad som angavs av det innehållande felet.

Error

Feldefinition.

Name Typ Description
code

string

Tjänstspecifik felkod som fungerar som understatus för HTTP-felkoden.

details

Error[]

Intern felinformation.

innererror

InnerError

Ett objekt som innehåller mer specifik information än det aktuella objektet om felet.

message

string

En läsbar återgivning av felet.

ErrorResponse

Felsvar.

Name Typ Description
error

Error

Felinformationen.

InnerError

En mer specifik felbeskrivning än vad som angavs av det innehållande felet.

Name Typ Description
code

string

En mer specifik felkod än vad som angavs av det innehållande felet.

innererror

InnerError

Ett objekt som innehåller mer specifik information än det aktuella objektet om felet.