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.
DELETE
privilege for the MDM.Data.Entities.History
resource (or ROLE_ADMIN_TENANT
).Request
GET {TenantURL}/{entity object URI}
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:
For example:
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:
For example, | |
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:
| |
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. |
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.
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": []
}
]
}