Twins - DigitalTwins ListRelationships

Service:

Azure Digital Twins

API Version:

2023-10-31

Lekéri a kapcsolatokat egy digitális ikerpéldányból. Állapotkódok:

• 200 OK
• 400 – Hibás kérés
  • InvalidArgument – A digitális ikerpéldány azonosítója érvénytelen.
• 404 Nem található
  • DigitalTwinNotFound – A digitális ikerpéldány nem található.

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

With optional parameters:

GET https://digitaltwins-hostname/digitaltwins/{id}/relationships?relationshipName={relationshipName}&api-version=2023-10-31

URI-paraméterek

Name	In	Kötelező	Típus	Description
id	path	True	string	A digitális ikerpéldány azonosítója. Az azonosító egyedi a szolgáltatáson belül, és megkülönbözteti a kis- és nagybetűt.
api-version	query	True	string	A kért API-verzió.
relationshipName	query		string	A kapcsolat neve.

Kérelem fejléce

Name	Kötelező	Típus	Description
traceparent		string	Azonosítja a kérést egy elosztott nyomkövetési rendszerben.
tracestate		string	Szállítóspecifikus nyomkövetési azonosítási információkat biztosít, és a nyomkövetési adatok kiegészítője.

Válaszok

Name	Típus	Description
200 OK	RelationshipCollection	Siker
Other Status Codes	ErrorResponse	Alapértelmezett válasz. Headers x-ms-error-code: string

Biztonság

oauth2

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

Példák

List relationships

List relationships by name

List relationships

Sample Request

HTTP

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

Sample Response

Status code:

200

{
  "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

HTTP

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

Sample Response

Status code:

200

{
  "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"
}

Definíciók

Name	Description
Error	Hibadefiníció.
ErrorResponse	Hibaválasz.
InnerError	Pontosabb hibaleírás, mint amelyet a hiba tartalmazott.
RelationshipCollection	A digitális ikerpéldányokat összekapcsoló kapcsolatok gyűjteménye.

Error

Hibadefiníció.

Name	Típus	Description
code	string	Szolgáltatásspecifikus hibakód, amely a HTTP-hibakód alállapotaként szolgál.
details	Error[]	Belső hiba részletei.
innererror	InnerError	Egy objektum, amely az aktuális objektumnál pontosabb információt tartalmaz a hibáról.
message	string	A hiba emberi olvasásra alkalmas ábrázolása.

ErrorResponse

Hibaválasz.

Name	Típus	Description
error	Error	A hiba részletei.

InnerError

Pontosabb hibaleírás, mint amelyet a hiba tartalmazott.

Name	Típus	Description
code	string	Pontosabb hibakód, mint amit a tartalmazó hiba adott meg.
innererror	InnerError	Egy objektum, amely az aktuális objektumnál pontosabb információt tartalmaz a hibáról.

RelationshipCollection

A digitális ikerpéldányokat összekapcsoló kapcsolatok gyűjteménye.

Name	Típus	Description
nextLink	string	Egy URI az objektumok következő oldalának lekéréséhez.
value	object[]	A kapcsolatobjektumok.