Delen via


Twins - DigitalTwins UpdateComponent

Updates een onderdeel op een digitale dubbel. Statuscodes:

  • 204 Geen inhoud
  • 400 Ongeldige aanvraag
    • InvalidArgument: de id van de digitale dubbel, het onderdeelpad of de nettolading is ongeldig.
    • JsonPatchInvalid: de opgegeven JSON-patch is ongeldig.
    • ValidationFailed : het toepassen van de patch resulteert in een ongeldige digitale dubbel.
  • 404 Niet gevonden
    • DigitalTwinNotFound - De digitale dubbel is niet gevonden.
  • 412 Voorwaarde is mislukt
    • PreconditionFailed: de voorwaardecontrole (If-Match of If-None-Match) is mislukt.
PATCH https://digitaltwins-hostname/digitaltwins/{id}/components/{componentPath}?api-version=2023-10-31

URI-parameters

Name In Vereist Type Description
componentPath
path True

string

De naam van het DTDL-onderdeel.

id
path True

string

De id van de digitale dubbel. De id is uniek binnen de service en hoofdlettergevoelig.

api-version
query True

string

De aangevraagde API-versie.

Aanvraagkoptekst

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

Name Vereist Type Description
If-Match

string

Voer de bewerking alleen uit als de etag van de entiteit overeenkomt met een van de opgegeven etags of * is opgegeven.

traceparent

string

Identificeert de aanvraag in een gedistribueerd traceringssysteem.

tracestate

string

Biedt leverancierspecifieke traceringsidentificatie-informatie en is een aanvulling op traceringsouder.

Aanvraagbody

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

Name Type Description
patchDocument

object[]

Een updatespecificatie die wordt beschreven door JSON Patch. Updates voor eigenschapswaarden en $model elementen kunnen plaatsvinden in dezelfde aanvraag. Bewerkingen zijn beperkt tot toevoegen, vervangen en verwijderen.

Antwoorden

Name Type Description
204 No Content

Geslaagd

Headers

ETag: string

Other Status Codes

ErrorResponse

Standaardantwoord.

Headers

x-ms-error-code: string

Beveiliging

oauth2

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

Voorbeelden

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

Definities

Name Description
Error

Foutdefinitie.

ErrorResponse

Foutreactie.

InnerError

Een specifiekere foutbeschrijving dan is opgegeven door de betreffende fout.

Error

Foutdefinitie.

Name Type Description
code

string

Servicespecifieke foutcode die fungeert als de substatus voor de HTTP-foutcode.

details

Error[]

Interne foutdetails.

innererror

InnerError

Een object met specifiekere informatie dan het huidige object over de fout.

message

string

Een door mensen leesbare weergave van de fout.

ErrorResponse

Foutreactie.

Name Type Description
error

Error

De foutdetails.

InnerError

Een specifiekere foutbeschrijving dan is opgegeven door de betreffende fout.

Name Type Description
code

string

Een specifiekere foutcode dan is opgegeven door de betreffende fout.

innererror

InnerError

Een object met specifiekere informatie dan het huidige object over de fout.