Get Relationship By RelationshipID

This endpoint is used to get relationship of a specific relationshipID on the graph. Application user has to provide the ercollectionid as part of header body and relationshipType as part of URL to fetch all relationships of a specific relationshipType from specific partition.

URL

https://{{HOST}}/apollo/graph/relationships({relationshipID})?v={version}
https://{{HOST}}/apollo/graph/relationships($filter={relationshipID})?v={version}

Method

Required IMS Scopes

• apollo_read

Versions Supported

1.0 (Default)
1.1
1.2

URL Query Parameter

URL Path Parameters

Request Header Parameters

Example

Request

curl -X GET 
'https://{{HOST}}/apollo/graph/relationships(JCI-507-B1-F1-isPartOf-JCI-507-B1)?v=1.1' 
  -H 'Authorization: Bearer {{access_token}}' 
  -H 'Content-Type: application/json' 
  -H 'ercollectionid: TestER-DVDocs' 
  -H 'first: 100' 
  -H 'after: 0' 

curl -X GET 
'https://{{HOST}}/apollo/graph/relationships($filter=JCI-507-B1-F1-isPartOf-JCI-507-B1)?v=1.1' 
  -H 'Authorization: Bearer {{access_token}}' 
  -H 'Content-Type: application/json' 
  -H 'ercollectionid: TestER-DVDocs' 
  -H 'first: 100' 
  -H 'after: 0' 

Response

 {
    "status": {
        "message": "",
        "code": "200"
    },
    "data": [
        {
            "id": "JCI-507-B1-F1-isPartOf-JCI-507-B1",
            "destinationEntityId": "JCI-507-B1",
            "relationshipType": "BRICK_0_4__isPartOf_Location_Location",
            "brickRelationshipName": "",
            "sourceERCollectionId": "TestER-DVDocs",
            "relationshipName": "JCI-507-B1-F1 isPartOf JCI-507-B1",
            "brickRelationshipType": "BRICK_0_4__isPartOf",
            "sourceEntityId": "JCI-507-B1-F1",
            "destinationERCollectionId": "TestER-DVDocs"
        }
    ],
    "paging": {
        "totalCount": 1,
        "continuationToken": null
    }
}

Errors