Unify and manage your data

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 for each attribute and each value of an attribute. When you use showAppliedSurvivorshipRules, the ovDetails section has the following fields:
    • appliedSurvivorshipRules (legacy): Contains the applied survivorship strategy and fallback information. This legacy response format is retained for backward compatibility.

    • appliedSurvivorshipRuleTree (recommended): Provides a more detailed version of the applied survivorship strategy and fallback strategies, including source ordering information where applicable. The following response fields are supported:

      • appliedSurvivorshipRule: Name of the survivorship strategy applied at the current level.
      • sourcesUriOrder: Ordered list of source URIs for an SRC_SYS strategy. This field is omitted for other strategies and when sourcesUriOrderDerivedFrom is none.
      • sourcesUriOrderDerivedFrom: Indicates how sourcesUriOrder was derived for an SRC_SYS strategy. The following values are supported:
        • mapping: The source order is configured at the mapping level. The API returns the sourcesUriOrder value from the L3 mapping configuration.
        • group: The source order is configured at the group level. The API returns the sourcesUriOrder value from the L3 group configuration.
        • priority: The source order is derived from sources associated with the attribute that have an L3 priority. The API returns the sources in descending priority order.
        • none: No priority or source order is configured, or no applicable source order is found. The response omits sourcesUriOrder.
      • fallbacks: List of fallback strategies. Each fallback contains appliedSurvivorshipRule and fallbacks. An SRC_SYS fallback also includes sourcesUriOrderDerivedFrom and, where applicable, sourcesUriOrder.

    A sample response is given below:

    {
      "ovDetails": {
        "appliedSurvivorshipRules": {
          "SRC_SYS": [
            "MinValue"
          ]
        },
        "appliedSurvivorshipRuleTree": {
          "appliedSurvivorshipRule": "SRC_SYS",
          "sourcesUriOrder": [
            "configuration/sources/SRC1",
            "configuration/sources/SRC2"
          ],
          "sourcesUriOrderDerivedFrom": "mapping",
          "fallbacks": [
            {
              "appliedSurvivorshipRule": "MinValue",
              "fallbacks": []
            }
          ]
        },
        "appliedSurvivorshipGroup": "GroupA",
        "participationStatus": "strategy"
      }
    }
    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 includes the following root-level and rule-level fields:
    • appliedSurvivorshipGroup: Applied survivorship group for the attribute value.
    • participationStatus: Indicates how the attribute value participates in OV calculation.
    • matchedFilters: Filters from the business configuration that matched during survivorship evaluation.
    • unmatchedFilters: Filters from the business configuration that did not match during survivorship evaluation.
    • winnerCrosswalks: Final list of winner crosswalks for the OV value. Each object contains type, which identifies the source type URI, and value, which identifies the crosswalk value.
    • appliedSurvivorshipRule: The survivorship rule applied at the current level.
    • sourcesUriOrder: Displays an ordered list of source URIs for a SRC_SYS strategy. This field is omitted for other strategies and when sourcesUriOrderDerivedFrom is none.

    • sourcesUriOrderDerivedFrom: Indicates how sourcesUriOrder was derived for an SRC_SYS strategy. The following values are supported:
      • mapping: The source order is configured at the mapping level. The API returns the sourcesUriOrder value from the L3 mapping configuration.
      • group: The source order is configured at the group level. The API returns the sourcesUriOrder value from the L3 group configuration.
      • priority: The source order is derived from sources associated with the attribute that have an L3 priority. The API returns the sources in descending priority order.
      • none: No priority or source order is configured, or no applicable source order is found. The response omits sourcesUriOrder.
    • winningCrosswalks: Winner crosswalk sources returned by the rule applied at the current level.
    • sourcesForOv: Reference to the sourcesForOv setting from the business configuration for the current rule.
    • fallbackCriteria: Reference to the fallback criteria from the business configuration. Supported values are ZERO, ZERO_OR_MORE_THAN_ONE, and MORE_THAN_ONE.
    • fallbacks: List of fallback rules. Each fallback contains the same fields as the parent rule: appliedSurvivorshipRule, winningCrosswalks, sourcesForOv, fallbackCriteria, and fallbacks. An SRC_SYS fallback also includes sourcesUriOrderDerivedFrom and, where applicable, sourcesUriOrder.
    A sample response is given below:
{
  "ovDetails": {
    "winnerCrosswalks": [
      {
        "type": "configuration/sources/LNKD",
        "value": "LNKD_RANK"
      }
    ],
    "appliedSurvivorshipGroup": "default",
    "participationStatus": "strategy",
    "unmatchedFilters": [
      {
        "and": [
          {
            "uri": "configuration/entityTypes/HCO/attributes/MultipleFilters",
            "value": "matchedValue",
            "operator": "ne"
          }
        ]
      }
    ],
    "appliedSurvivorshipRules": {
      "appliedSurvivorshipRule": "SRC_SYS",
      "sourcesUriOrder": [
        "configuration/sources/LNKD",
        "configuration/sources/SRC2"
      ],
      "sourcesUriOrderDerivedFrom": "mapping",
      "fallbacks": [
        {
          "appliedSurvivorshipRule": "MinValue",
          "fallbacks": [],
          "fallbackCriteria": "MORE_THAN_ONE",
          "winningCrosswalks": [
            {
              "type": "configuration/sources/LNKD",
              "value": "LNKD_RANK"
            }
          ],
          "sourcesForOv": [
            "configuration/sources/LNKD"
          ]
        }
      ],
      "fallbackCriteria": "MORE_THAN_ONE",
      "winningCrosswalks": [
        {
          "type": "configuration/sources/LNKD",
          "value": "LNKD_RANK"
        }
      ],
      "sourcesForOv": [
        "configuration/sources/LNKD"
      ]
    },
    "matchedFilters": [
      {
        "and": [
          {
            "uri": "configuration/entityTypes/HCO/attributes/MultipleFilters",
            "value": "unmatchedValue",
            "operator": "ne"
          }
        ]
      },
      {
        "equals": [
          {
            "uri": "configuration/entityTypes/HCO/attributes/MultipleFilters",
            "value": "matchedValue"
          }
        ]
      }
    ]
  }
}
reverseTranscodeLookupsNo

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 {your-access-token}

Response

GET {TenantURL}/relations/r1
Headers: Authorization: Bearer {your-access-token}
{
    "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"
            ]
        }
    ]
}