Dela via


Twins - DigitalTwins ListRelationships

Hämtar relationerna från en digital tvilling. Statuskoder:

  • 200 OK
  • 400 Felaktig begäran
    • InvalidArgument – ID:t för den digitala tvillingen är ogiltigt.
  • 404 – Hittades inte
    • DigitalTwinNotFound – Den digitala tvillingen hittades inte.
GET https://digitaltwins-hostname/digitaltwins/{id}/relationships?api-version=2023-10-31
GET https://digitaltwins-hostname/digitaltwins/{id}/relationships?relationshipName={relationshipName}&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.

api-version
query True

string

Den begärda API-versionen.

relationshipName
query

string

Namnet på relationen.

Begärandehuvud

Name Obligatorisk Typ Description
traceparent

string

Identifierar begäran i ett distribuerat spårningssystem.

tracestate

string

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

Svar

Name Typ Description
200 OK

RelationshipCollection

Klart

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

List relationships
List relationships by name

List relationships

Sample Request

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

Sample Response

{
  "value": [
    {
      "$sourceId": "mySourceTwin",
      "$relationshipId": "firstRelationshipId",
      "$targetId": "targetTwinId",
      "$relationshipName": "myRelationship",
      "$etag": "W/\"1553dbf5-0052-4be8-bea8-46269075b503\"",
      "property": "value"
    },
    {
      "$sourceId": "mySourceTwin",
      "$relationshipId": "secondRelationshipId",
      "$targetId": "targetTwinId",
      "$relationshipName": "myRelationship",
      "$etag": "W/\"2552a0a7-0666-4d5e-a67f-ece5b9b81fe0\"",
      "property": "value"
    }
  ],
  "nextLink": "url-to-next-page"
}

List relationships by name

Sample Request

GET https://digitaltwins-hostname/digitaltwins/mySourceTwin/relationships?relationshipName=myRelationship&api-version=2023-10-31

Sample Response

{
  "value": [
    {
      "$sourceId": "mySourceTwin",
      "$relationshipId": "firstRelationshipId",
      "$targetId": "targetTwinId",
      "$relationshipName": "myRelationship",
      "$etag": "W/\"1553dbf5-0052-4be8-bea8-46269075b503\"",
      "property": "value"
    },
    {
      "$sourceId": "mySourceTwin",
      "$relationshipId": "secondRelationshipId",
      "$targetId": "targetTwinId",
      "$relationshipName": "myRelationship",
      "$etag": "W/\"2552a0a7-0666-4d5e-a67f-ece5b9b81fe0\"",
      "property": "value"
    }
  ],
  "nextLink": "url-to-next-page"
}

Definitioner

Name Description
Error

Feldefinition.

ErrorResponse

Felsvar.

InnerError

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

RelationshipCollection

En samling relationer som relaterar digitala tvillingar tillsammans.

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.

RelationshipCollection

En samling relationer som relaterar digitala tvillingar tillsammans.

Name Typ Description
nextLink

string

En URI för att hämta nästa sida med objekt.

value

object[]

Relationsobjekten.