Get Entity

Learn how to fetch an entity object (full or partial) by URI from your tenant.

This operation returns an entity object (full or partial) by URI from the tenant.

Important: You must have the DELETE privilege for the MDM.Data.Entities.History resource (or ROLE_ADMIN_TENANT).

Request

GET {TenantURL}/{entity object URI}

Table 1. Parameters
Parameter		Required	Default Value	Description
Headers	Authorization	Yes		Provides 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	`sendHidden=disabled`	Passes a comma-separated list of options for content to include in the response: `sendHidden`: Entities with hidden attributes. `ovOnly`: Only attribute values that have the `ov=true` flag. `nonOvOnly`: 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. `serializeInitialSourcesInCrosswalks`: URIs of initial sources in crosswalks. `cleanEntity`- Set this option to `true` to get entities without certain properties. Here's what you get in the response: URI is null. Type of entity is available. createdBy, createdTime, updatedBy, and updatedTime are included. Simple and nested attributes are displayed without the uri, ov, type, and label parameters. For refEntity and refRelation, the `uri`, `type`, `createDate`,`updateDate`, `attributeURIs`, `startRefPinned`, `endRefPinned`, `startRefIgnored`, `endRefIgnored`, and `objectURI` are included. Field crosswalks type is updated with its `short name`, `reltioLoadDate`, `createDate`, and `updateDate`. Field attributes for crosswalk block contains only short URIs. singleAttributeUpdateDates field for crosswalk block is empty. `analyticsAttributes` is not included.
	mergeDuplicateCrosswalks	No		Checks if all crosswalks for the required entity are unique if set to `true`.
	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. Note: This restriction is intended for the UI convenience, when there are long lists of values for some of the attributes.
	explicitSurvivorshipGroup	No		Specifies the survivorship group that must be used for OV calculation. For example, `explicitSurvivorshipGroup=configuration/entityTypes/Individual/survivorshipGroups/FirstNameFrequency`.
	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 relationship API.
	sendMasked	No		Provides masked data for a profile in viewing mode, if it is set to True. For example, when you run the GET endpoint `GET /reltio/api/{tenantId}/entities/{id}` with sendMasked=True, the UI sends the parameter for masked data. If you run it with sendMasked=False, the UI executes `GET https://<env>.reltio.com/nui/reltioAPI/api/<tenant_id>/entities/<entity_id>/attributes/<attribute>/<?>/<subattribute>/<?>`. If you want the masked data again, the UI clears the plain text values and gets the masked version. Note: By default, the sendMasked value is set to False for backward compatibility with unsupported UI components. The data is not masked for an entity in editing and suggesting mode.

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, an entity attribute value in RDM is Male for the Gender attribute and its corresponding value is M in a source application. When the data comes to Reltio from the source application, the system transcodes M value to a canonical or a standard value, Male. 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 M.

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}/entities/10?select=uri,type,tags
Headers: Authorization: Bearer 204938ca-2cf7-44b0-b11a-1b4c59984512

Response

GET {TenantURL}/entities/10?select=uri,type,tags 
Headers: Authorization: Bearer 204938ca-2cf7-44b0-b11a-1b4c59984512 
{
    "uri": "entities/10",
    "type": "configuration/entityTypes/Individual",
    "tags": [
        "sport",
        "movies"
    ],
    "crosswalks": [
        {
            "uri": "entities/10/crosswalks/1",
            "type": "configuration/sources/Reltio",
            "value": "entities/10",
            "attributeURIs": []
        }
    ]
}

Unify and manage your data

Get Entity

Request

Reverse Transcoding

Response

Request

Response

Footer