Read Relationship Operation

The read relationship operation returns property values for a relationship in a Data Hub model.

HTTP GET URL Format

The request is specified as follows. The Spectrum server supports both HTTP and HTTPS.

GET http://server_name:port/rest/DataHub/operations/modelName/relationships/relationshipLabel?query_parameters

URL Path Elements

modelName: The name of the Data Hub model.
relationshipLabel: The name of the relationship label connecting two entities in a model.

Query Parameters


Parameter	Type	Required	Description
sourceID	string	yes	The source ID of the entity that connects a relationship. This parameter specifies an entityType:entityLabel value pair.
targetID	string	yes	The target ID of the entity that connects a relationship. This parameter specifies an entityType:entityLabel value pair.
uniqueID	string	no	The value that distinguishes a relationship when there are multiple relationships with the same label connecting two entities in a model.

Response

The operation returns the status code "200 OK" when it is successful. The operation returns the status code 500 (Error) when it fails.

The response returns a name-value pair for each relationship property in the following format, when a relationship has N properties.

{"result":{
    "Property1":"Value1",
    "Property2":"Value2",
     ...
    "PropertyN":"ValueN"
 }}

Read relationship with JSON response

The following request reads properties from the Roomate relationship label in the "911" model between two person entities.

GET http://localhost:8080/rest/DataHub/operations/911/relationships/Roomate?sourceID=Person:Ahmed%20al-Haznawi&targetID=Person:Ziad%20Jarrah

This results in the following response:

{"result":{
    "Date":1275782400000,
    "Rank":"0"
    }}

Note: Date, time, and date-time property values are UNIX Epoch time values formatted as long data type in both requests and responses.

Read relationships with same label

The following request reads properties from the Roomate relationship label in the "911" model where the relationship ID between two person entities is equal to "4".

GET http://localhost:8080/rest/DataHub/operations/911/relationships/Roomate?sourceID=Person:Ahmed%20al-Haznawi&targetID=Person:Ziad%20Jarrah&uniqueID=4