Retrieve Twin graph.

Request

Retrieves a twin by its ID along with its associated twins as defined in the request. The relationships field in the request is optional. Twins will be returned in the response even if the nested relationships failed to find a twin. Similar to a sql outer join semantics.

Security

oauth2

Bodyapplication/jsonrequired

Instance of GetTwinGraphRequest.

aliasstringrequired

Name of the Primary Twin Collection.

Example:"Twin"

idstringrequired

DtId of the Primary Twin.

Example:"PNT2Uga"

relationshipsArray of objects(RequestGraphRelationship)

Graph relationship definition to retrieve the related twins.

Example:

[
  {
    "alias": "Components",
    "relationshipNames": [ … ],
    "modelNames": [ … ],
    "exactModelMatch": false,
    "direction": "Incoming",
    "relationship": { … }
  },
  {
    "alias": "TwinPoints",
    "relationshipNames": [ … ],
    "modelNames": [],
    "exactModelMatch": false,
    "direction": "Incoming",
    "relationship": {}
  }
]

{
  "id": "PNT2Uga",
  "alias": "Twin",
  "relationships": [
    { … },
    { … }
  ]
}

Responses

Twin Graph Response.

Bodyapplication/json

<property name>Array of objects(DigitalTwinWithRelationships)additional property

Example:

[
  {
    "id": "TW-DD-II-L01",
    "modelId": "dtmi:com:willowinc:Level;1",
    "lastUpdateTime": "2024-08-30T03:49:30.4062816+00:00",
    "contents": { … },
    "incomingRelationships": [ … ],
    "outgoingRelationships": [ … ]
  }
]

Response

{
  "property1": [
    { … }
  ],
  "property2": [
    { … }
  ]
}