The read relationship operation returns property values for a relationship in a Context Graph 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/ContextGraph/operations/modelName/relationships/relationshipLabel?query_parameters
URL Path Elements
- modelName
- The name of the Context Graph 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. |
Return codes
The operation returns the status code "200 OK" when it is successful. The operation returns the status code 500 (Error) when it fails.
Response
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"
}}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/ContextGraph/operations/911/relationships/Roomate?sourceID=Person:Ahmed%20al-Haznawi&targetID=Person:Ziad%20JarrahThis results in the following response:
{"result":{
"Date":1275782400000,
"Rank":"0"
}}