# Retrieve Twin graph.

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.

Endpoint: POST /twins/graph
Version: v3
Security: oauth2

## Request fields (application/json):

  - `alias` (string)
    Name of the Primary Twin Collection.
    Example: "Twin"

  - `id` (string)
    DtId of the Primary Twin.
    Example: "PNT2Uga"

  - `relationships` (array)
    Graph relationship definition to retrieve the related twins.
    Example: [{"alias":"Components","relationshipNames":["isPartOf"],"modelNames":["dtmi:com:willowinc:Fan;1"],"exactModelMatch":false,"direction":"Incoming","relationship":{"alias":"ComponentPoints","relationshipNames":["isCapabilityOf"],"modelNames":[],"exactModelMatch":false,"direction":"Incoming","relationship":{}}},{"alias":"TwinPoints","relationshipNames":["isCapabilityOf"],"modelNames":[],"exactModelMatch":false,"direction":"Incoming","relationship":{}}]

  - `relationships.alias` (string)
    Name of the Related Twin Collection.

  - `relationships.relationshipNames` (array)
    Array of relationship names to filter, if empty all relationship names will be considered.
    Enum: "isPartOf", "isDocumentOf", "hasDocument", "isCapabilityOf", "locatedIn", "hostedBy", "includedIn", "servedBy", "leasee", "hasLease", "locatedInGridRegion", "isParameterOf", "isFedBy", "subMeterOf", "serves", "ownedBy", "manufacturedBy", "serviceResponsibility", "installedBy", "servicedBy"

  - `relationships.modelNames` (array)
    Array of Model Names to filter, if empty all model twins will be considered.
Get Twin Graph Request will match input models (and its descendants if exact Model match is false).

  - `relationships.exactModelMatch` (boolean)
    Gets a value indicating whether the model match is exact. Default is false.

  - `relationships.direction` (string)
    Twin Relationship Direction.
    Enum: "Incoming", "Outgoing", "IncomingOrOutgoing"

  - `relationships.relationship` (object)
    Request to retrieve graph relationship twins.

## Response 403 fields (application/json):

  - `type` (string,null)

  - `title` (string,null)

  - `status` (integer,null)

  - `detail` (string,null)

  - `instance` (string,null)

## Response 404 fields (application/json):

  - `type` (string,null)

  - `title` (string,null)

  - `status` (integer,null)

  - `detail` (string,null)

  - `instance` (string,null)


## Response 504 fields