Get Entity with Survivorship Rules

Learn more about finding the OV values for a survivorship group.

Use this api to find out the OV values for a survivorship group. This operation returns an entity object (full or partial) by URI from the tenant, with the OV values calculated for the survivorship group provided in the request body.

Request

POST {TenantURL}/{entity object uri}/_get_with_survivorship_rules

Table 1. Parameters
Parameter		Required	Description
Headers	`Authorization`	Yes	Information about authentication access token in the format "Bearer `<accessToken>`". For more information, see Authentication API.
Query	`select`	No	Generates a comma-separated list of properties from the entity structure that must be returned in a response. The response generates a partial entity object. For the `select` parameter, you can use the following fields in the request query: uri type tags createdBy createdTime updatedBy updatedTime isFavorite analyticsAttributes label secondaryLabel crosswalks attributes For example: `select=attributes.FirstName,attributes.LastName` `select=attributes` The first query retrieves only the entity's first name and last name in the response. The second query retrieves all the entity's attributes. Additional system properties are: `attributes._lookupCodes`: returns lookup codes for lookup attributes. `attributes._lookupValues`: returns values for lookup attributes. For example, `select=uri,label,attributes._lookupCodes,attributes._lookupValues.`
	`time`	No	Generates an object as it was in the Reltio system at some point in time (timestamp in ms).
	`options`	No	Comma-separated list of different options, which affect entity's JSON content in the response. Available options: `sendHidden`: disabled by default, the entity's JSON contains hidden attributes if this option is enabled. `ovOnly`: return only attribute values that have the `ov=true` flag. `nonOvOnly`: return only attribute values that have the `ov=false` flag. If you have a nested or reference attribute value, where `ov=true`, but subattributes, where `ov=false`, then these subattributes won’t appear in the response.
	`mergeDuplicateCrosswalks`	No	Specify `true` to check that all crosswalks for the required entity are unique.
	defaultMaxValues	No	Specifies the maximum number of values listed in attributes. This restriction is intended for the UI convenience in cases where there are long lists of values in some attributes.
	`explicitSurvivorshipGroup`	No	Specifies the survivorship group that must be used for OV calculation. For example, explicitSurvivorshipGroup=configuration/entityTypes/Individual/survivorshipGroups/FirstNameFrequency.
Body	`mapping`	Yes	Denotes the mapping parameters for survivorship groups. For example, `"mapping": [ { "attribute": "configuration/entityTypes/Individual/attributes/FirstName", "survivorshipStrategy": "Frequency" } ]`
	`sourcesUriOrder`	No	Denotes the ordered list of sources. This is used in SRC_SYS strategy as the default list for all SurvivorshipGroupMappings in the current group. For example, `"sourcesUriOrder": [ 'configuration/sources/ReltioCleanser', 'configuration/sources/FB' ]`
	sourcesForOv	No	Denotes the default list of sources that may be the original value. The sources not included in this list are ignored. You can override this list by the survivorship group mapping specified for the particular attribute. For example, `"sourcesForOv": [ 'configuration/sources/Reltio', 'configuration/sources/FB' ]`
	roles	No	Denotes the user roles for which this Survivorship group is applicable to. The list of roles can be specified to non-default survivorship group only.

The request body contains the following parameters:

Survivorship Group object: This parameter contains the survivorship group for which you want to calculate OV values.
Note: The survivorship group specified here will override the survivorship group specified in the explicitSurvivorshipGroup parameter in Get Entity.For more information, see topic Get Entity
.

Response

The response body contains the entity object by URI from the tenant, with the OV values for the specified survivorship group.

Example

Request

In this example, the survivorship configuration for configuration/entityTypes/Individual/ has every attribute using default survivorship rules, LUD. By creating a POST request to this endpoint we can calculate operational values according to the specified survivorship group. With the given request body, FirstName will have frequency as a winner.

POST {TenantURL}/entities/00005KL/_get_with_survivorship_rules
Headers: Authorization: Bearer 204938ca-2cf7-44b0-b11a-1b4c59984512
Body:
{
 "mapping": [
    {
      "attribute": "configuration/entityTypes/Individual/attributes/FirstName",
      "survivorshipStrategy": "Frequency"
    }
  ]
}

Response


   {
"uri" : "entities/00005KL",
"type" : "configuration/entityTypes/Individual",
"attributes" : {
"FirstName" : [ {
"type" : "configuration/entityTypes/Individual/attributes/FirstName",
"ov" : true,
"value" : "Cat",
"uri" : "entities/00005KL/attributes/FirstName/0"
}, {
"type" : "configuration/entityTypes/Individual/attributes/FirstName",
"ov" : false,
"value" : "Bob",
"uri" : "entities/00005KL/attributes/FirstName/9"
} ],
"Gender" : [ {
"type" : "configuration/entityTypes/Individual/attributes/Gender",
"ov" : true,
"value" : "Male",
"uri" : "entities/00005KL/attributes/Gender/10"
}, {
"type" : "configuration/entityTypes/Individual/attributes/Gender",
"ov" : false,
"value" : "Female",
"uri" : "entities/00005KL/attributes/Gender/1"
} ]
},
"crosswalks" : [ {
"uri" : "entities/00005KL/crosswalks/2",
"type" : "configuration/sources/FB",
"value" : "10f5ebf9-67be-4030-ad72-8f0020068318",
"createDate" : "2022-11-21T22:02:12.663Z",
"updateDate" : "2022-11-21T22:02:12.663Z",
"attributes" : [ "entities/00005KL/attributes/FirstName/0", "entities/00005KL/attributes/Gender/1" ],
}, {
"uri" : "entities/00005KL/crosswalks/3",
"type" : "configuration/sources/FB",
"value" : "da5b5322-2e5b-4050-8dbf-b6490706ab8b",
"createDate" : "2022-11-21T22:02:12.663Z",
"updateDate" : "2022-11-21T22:02:12.663Z",
"attributes" : [ "entities/00005KL/attributes/FirstName/0", "entities/00005KL/attributes/Gender/1" ],
}, {
"uri" : "entities/00005KL/crosswalks/6",
"type" : "configuration/sources/FB",
"value" : "1a3ca425-6c0e-44de-bc16-5e1fc7b4b07b",
"createDate" : "2022-11-21T22:02:12.985Z",
"updateDate" : "2022-11-21T22:02:12.985Z",
"attributes" : [ "entities/00005KL/attributes/FirstName/9", "entities/00005KL/attributes/Gender/10" ],
} ],
"analyticsAttributes" : { },
"label" : "",
"secondaryLabel" : ""
}

Accelerate the Value of Data

Get Entity with Survivorship Rules

Request

Response

Example

Footer