Get Relationship

Learn how to retrieve a specific relationship object using its URI and optional query parameters.

Request

GET {TenantURL}/{relation object URI}

Table 1. Parameters
Parameter		Required	Details
Headers	authorization	Yes	Provides information about the authentication access token in format "Bearer `<accessToken>`" (see details in Authentication API ).
Query	options	No	Passes a comma-separated list of options for the relationships the API should return: `sendHidden`: Relationships with hidden attributes. `resolveMergedEntities`: Actual winner URIs for start/end objects in the relation if `true`. `showAppliedSurvivorshipRules`- Returns the survivorship determination logic used to determine the OV value of an attribute, down to the lowest level (the primary and fallback strategies in order they were applied) for each attribute and each value of an attribute. A sample response is given below: `{ "ovDetails": { "appliedSurvivorshipRules": { "Aggregation": [ "Aggregation ", "LUD" ] }, "appliedSurvivorshipGroup": "default", "participationStatus": "strategy", "matchedFilters": [ { "and": [ { "uri": "configuration/entityTypes/HCO/attributes/MultipleFilters", "value": "unmatchedValue", "operator": "ne" } ] } ], "unmatchedFilters": [ { "uri": "configuration/entityTypes/HCO/attributes/MultipleFilters", "value": "matchedValue", "operator": "ne" } ] } }` Note: The `ovParticipationStatus` property indicates how an attribute value participates in OV calculation. It explicitly represents values that are excluded or handled differently during OV processing. This property supports the following values: `ignored`, `pinned`, `end-dated-crosswalk`, `not-participated`, and `strategy`. `explainOv` - returns additional survivorship diagnostics in the `ovDetails` section, including matched and unmatched filters as defined in the business configuration. It also includes all fields returned by `showAppliedSurvivorshipRule`. A sample response is given below: `{ "ovDetails": { "appliedSurvivorshipRules": { "Aggregation": [ "Aggregation ", "LUD" ] }, "appliedSurvivorshipGroup": "default", "participationStatus": "strategy", "matchedFilters": [ { "and": [ { "uri": "configuration/entityTypes/HCO/attributes/MultipleFilters", "value": "unmatchedValue", "operator": "ne" } ] } ], "unmatchedFilters": [ { "uri": "configuration/entityTypes/HCO/attributes/MultipleFilters", "value": "matchedValue", "operator": "ne" } ] } }`
Query	reverseTranscodeLookups	No	Provides the destination system name for which the system needs to perform reverse transcoding of RDM attributes. For example, to reverse transcode the lookup values used in Reltio to the values in Salesforce, set this parameter to Salesforce: `reverseTranscodeLookups=Salesforce` Note: You can use this parameter for RDM attributes in Get entity API.

Reverse Transcoding

If an attribute is bound by RDM, the system transcodes the value to a canonical or a standard value of Reltio. In certain cases, when Reltio sends the values back to the source application, it needs to provide the raw value according to that system. This is called reverse transcoding.

For example, a relationship attribute value in RDM is Engineering for the Department attribute and its corresponding value is Eng in a source application. When the data comes to Reltio from the source application, the system transcodes Eng value to a canonical or a standard value, Engineering. When the same value is sent back to the source application, which is reverseTranscodeLookups in this API call, it is reverse transcoded to the original value of Eng.

Note: If you have multiple values coming from a source application mapped to one standard or canonical value, then you can define the downStreamDefaultValue parameter and set it true for one of the source values. This value is used during reverse transcoding.

Response

JSON Object representing object with URI.

Request

GET {TenantURL}/relations/r1
Headers: Authorization: Bearer 204938ca-2cf7-44b0-b11a-1b4c59984512

Response

GET {TenantURL}/relations/r1
Headers: Authorization: Bearer 204938ca-2cf7-44b0-b11a-1b4c59984512
{
    "URI":"relations/r1",
    "type":"configuration/relationTypes/Employment",
    "startObject":{
        "URI":"relations/r1/startObject",
        "objectURI":"entities/e1",
        "type":"configuration/entityTypes/Individual",
        "label":"John Smith",
        "directionalLabel":"employee"
    },
    "endObject":{
        "URI":"relations/r1/endObject",
        "objectURI":"entities/e2",
        "type":"configuration/entityTypes/Organization",
        "label":"Super Company",
        "directionalLabel":"employer"
    },
    "attributes":{
        "URI": "relations/r1/attributes",
        "Title":[
            {
                "URI": "relations/r1/attributes/Title/1",
                "type": "configuration/relationTypes/Employment/attributes/Title",
                "value":"CEO"
            }
        ]
    },
    "crosswalks":[
        {
            "URI": "relations/r1/crosswalks/1",
            "type":"configuration/sources/MDM",
            "value":"Employemnt.1000",
            "attributes": [
                "relations/r1/attributes/Title/1"
            ]
        }
    ]
}

Unify and manage your data

Get Relationship

Request

Reverse Transcoding

Response

Request

Response

Footer