Entities API
Learn about the REST APIs to manage entities.
A Reltio entity describes a data object such as a person, organization, product, or location.
The Entities endpoints enable you to create, update, and delete entities and their attributes. The topics in this section describe how to define and manage entities in your data model using APIs. To help you understand how best to use API parameters and options to refine your requests, we provide sub topics with detailed usage scenarios and examples.
Note: All Data API requests must be signed with an authorization token that provides access rights. For more information, see Authentication API.
Alternatively, use the Console Data Model to define entity types and the Hub Profile views to manage specific instances of entities of defined types. For more information, see topics Define or refine your data model and Profiles at a glance.
Entity object structure
This table describes the properties that comprise Entity data objects
| Property | Description | Type |
|---|---|---|
URI
| Path that is used to reach an entity object. Format: entities/{entity_id}
| String, URI |
type
| Entity type of the entity instance. This is a reference to the entity type configuration by its URI. An entity can have just one entity type. | String, Entity Types URI |
label
| An entity label that is built using the entity type configuration dataLabelPattern and data of an entity. | String |
secondaryLabel
| An entity label that is built using the entity type configuration secondaryLabelPattern and data from an entity. Since label information is generally used in the results of a search, more information can be included in the entity label to give it more unique characteristics when displayed near similar results. | String |
tooltip
| An entity tooltip that is built using entity type configuration dataTooltipPattern and data of an entity. | String |
roles
| An array of entity roles associated with the entity. | Array of Roles URIs |
tags
| An array of tag strings associated with the entity. | Array of Strings |
attributes
| Attributes the entity possesses-can include simple, nested and reference attributes. Each attribute has a reference to its configuration type. Attributes are grouped by attribute configuration. | Attributes |
activeness
| Defined time period while the object is active. | Attributes |
crosswalks
| The crosswalks to source systems and data, for this entity. | Crosswalks |
analyticsAttributes
| Analytics attributes the entity possesses. Analytics attributes can include simple and nested attributes. Each analytics attribute has a reference to its configuration type. Analytics attributes are grouped by attribute configuration. | Analytics Attribute |
businessProcessData
| Business processes associated with the entity. | Array of business process data records |
createdBy
| User who created the entity. | String |
createdTime
| Timestamp when entity was created, in milliseconds. | UTC timestamp, ms |
updatedBy | The user who last updated the entity. This includes changes to structure, attributes, and reference relationships. | String |
updatedTime
| The system-level timestamp (in milliseconds) when the entity was last updated. This includes updates to attributes, structure, and reference relationships. | UTC timestamp, ms |
Note: The
updatedTime and updatedBy values reflect system-level operations and may differ from the most recent attribute-level change or user shown in Profile History. If your tenant has the skipEndDatedReferenceAttributes parameter set to true, changes to end-dated reference attributes are excluded from both the updatedTime and updatedBy values. This ensures that these fields reflect updates only to active data elements. If the parameter is not enabled, updates to end-dated references may still affect the entity's update metadata.
For more details on how Reltio handles end-dated reference attributes, see Ignore a relationship's end-date.
To view a complete audit trail — including who changed what and when — use the
Entity History endpoint. For accurate change sequencing, use the objectVersion property or the Entity History endpoint.
Entity object example
This example shows how these entity object properties are structured in a JSON file in the Reltio configuration.
{
"URI": "entities/e1",
"roles": [
"configuration/roles/Client",
"configuration/roles/Prospect"
],
"tags": [
"sport",
"movies"
],
"createdTime": 1351899105569,
"createdBy": "admin",
"updatedTime": 1353933493738,
"updatedBy": "fadler",
"startDate": 270431852,
"type": "configuration/entityTypes/Individual",
"label": "Ivan",
"tooltip": "Ivan",
"attributes": {
"URI": "entities/e1/attributes",
"FirstName": [{
"URI": "entities/e1/attributes/FirstName/1",
"type": "configuration/entityTypes/Individual/attributes/FirstName",
"value": "Ivan"
},
{
"URI": "entities/e1/attributes/FirstName/2",
"type": "configuration/entityTypes/Individual/attributes/FirstName",
"value": "John"
}
],
"Education": [{
"URI": "entities/e1/attributes/Education/3",
"type": "configuration/entityTypes/Individual/attributes/Education",
"value": {
"University": [{
"URI": "entities/e1/attributes/Education/3/University/4",
"type": "configuration/entityTypes/Individual/attributes/Education/University",
"value": "UCSF"
},
{
"URI": "entities/e1/attributes/Education/3/University/5",
"type": "configuration/entityTypes/Individual/attributes/Education/University",
"value": "SPbGU"
}
]
}
}],
"Address": [{
"URI": "entities/e1/attributes/Address/6",
"entityURI": "entities/e2",
"type": "configuration/entityTypes/Individual/attributes/Address",
"value": {
"City": [{
"URI": "entities/e1/attributes/Address/6/City/7",
"type": "configuration/entityTypes/Location/attributes/City",
"value": "New York"
}],
"AddressType": [{
"URI": "entities/e1/attributes/Address/6/AddressType/8",
"type": "configuration/relationshipTypes/HasAddress/attributes/AddressType",
"value": "Home"
}]
}
}]
},
"crosswalks": [{
"URI": "entities/e1/crosswalks/1",
"type": "configuration/sources/MDM",
"value": "Person.781",
"attributeURIs": [
"entities/e1/attributes/FirstName/1",
"entities/e1/attributes/FirstName/2",
"entities/e1/attributes/Education/3/University/4",
"entities/e1/attributes/Education/3/University/5"
]
}]
}