Dela via


Twins - DigitalTwins AddRelationship

Lägger till en relation mellan två digitala tvillingar. Statuskoder:

  • 200 OK
  • 400 Felaktig begäran
    • InvalidArgument – ID för digitala tvillingar, relations-ID eller nyttolast är ogiltigt.
    • InvalidRelationship – relationen är ogiltig.
    • OperationNotAllowed – Relationen kan inte ansluta till samma digitala tvilling.
    • ValidationFailed – relationsinnehållet är ogiltigt.
  • 404 – Hittades inte
    • DigitalTwinNotFound – Den digitala tvillingen hittades inte.
    • TargetTwinNotFound – Målet för den digitala tvillingen för relationen hittades inte.
  • 412 Förhandsvillkoret misslyckades
    • PreconditionFailed – förhandsvillkorskontrollen (If-Match eller If-None-Match) misslyckades.
PUT https://digitaltwins-hostname/digitaltwins/{id}/relationships/{relationshipId}?api-version=2023-10-31

URI-parametrar

Name I Obligatorisk Typ Description
id
path True

string

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

relationshipId
path True

string

ID för relationen. ID:t är unikt inom den digitala tvillingen och skiftlägeskänsligt.

api-version
query True

string

Den begärda API-versionen.

Begärandehuvud

Name Obligatorisk Typ Description
If-None-Match

string

Utför endast åtgärden om entiteten inte redan finns.

traceparent

string

Identifierar begäran i ett distribuerat spårningssystem.

tracestate

string

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

Begärandetext

Name Typ Description
relationship

object

Data för relationen.

Svar

Name Typ Description
200 OK

Relationship

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

Create a relationship
Create a relationship (with properties)

Create a relationship

Sample Request

PUT https://digitaltwins-hostname/digitaltwins/mySourceTwin/relationships/myRelationshipId?api-version=2023-10-31

{
  "$targetId": "myTargetTwin",
  "$relationshipName": "myRelationship"
}

Sample Response

{
  "$relationshipId": "myRelationshipId",
  "$sourceId": "mySourceTwin",
  "$targetId": "myTargetTwin",
  "$relationshipName": "myRelationship",
  "$etag": "W/\"1553dbf5-0052-4be8-bea8-46269075b503\""
}

Create a relationship (with properties)

Sample Request

PUT https://digitaltwins-hostname/digitaltwins/mySourceTwin/relationships/myRelationshipId?api-version=2023-10-31

{
  "$targetId": "myTargetTwin",
  "$relationshipName": "myRelationship",
  "relationshipProperty1": 1,
  "relationshipProperty2": "some value"
}

Sample Response

{
  "$relationshipId": "myRelationshipId",
  "$sourceId": "mySourceTwin",
  "$targetId": "myTargetTwin",
  "$relationshipName": "myRelationship",
  "relationshipProperty1": 1,
  "relationshipProperty2": "some value",
  "$etag": "W/\"1553dbf5-0052-4be8-bea8-46269075b503\""
}

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 mänsklig läsbar representation 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.