Find Connected Parties
Use this API to find for an entity, its relation to other parties and also get profiles of the related parties.
The Find connected parties API enables you to search for entities and find it's related entities. Earlier where you were using multiple APIs to do these operations, the same can be achieved using this API. It also improves the latency, thus saving some time on execution and extra network latency.
This API uses a filter to search for entities, finds other entities related to the main entity by a specific relationship type, and returns all entities along with reference attributes.
In response, the count of entities (for both the main entities and related entities) and their reference attributes are returned.
Request:
POST /reltio/api/<tenantId>/entities/_findConnectedParties?max=50&returnAnalyticAttributes=false
| Parameters | Name | Required | Details |
|---|---|---|---|
| Headers | Authorization | Yes | Information about the authentication access token in the format "Bearer <accessToken>" (see details in Authentication API ). |
Content-Type | Yes | Should be "Content-Type: application/json". | |
| Body | relationTypes | No | The type of relation that connects two entities. The API searches for entities based on the relationship type specified here. If empty, then the result would contain search results only. |
entityTypes | No |
The types of entities that must be returned in the response. If empty no profiles are returned. | |
| referenceAttributesForTypes | No | The types of entities that should be returned with reference attributes. If this parameter is empty, then all entities will be returned without reference attributes. | |
filter | No |
You can specify any valid search filter. Based on the filter, the first 50 matching entities are considered from the search response. To increase this number, you can specify the number in the | |
| Query | select | No | Comma-separated list of properties from entity structure that should be returned in a response. Allows you to return partial entity object. List of entity object properties you can find here-Entities. Additional system properties are:
select=URI,label,attributes._lookupCodes,attributes._lookupValues |
max | No |
The maximum number of entities of the search response to be used. By default, the first 50 entities are considered. | |
offset | No | Positive Integer value to identify starting what element in a result set should be returned in a response. Can be used to organize pagination in combination with the max parameter. Default value is 0.Note: The updated maximum value and offset parameters, when combined, must not exceed the value of 10,000. Some examples of valid combinations are:
| |
sort | No | Sort parameter is used with Order parameter. Sort parameter points to the attribute or a list of attributes where ordering must be applied. If you order the result set as ascending or descending (reversed), you must use the Sort parameter to list the attributes that must be used for ordering.Example: Important: The sorting will not be used if this parameter is not provided or the value is not recognized. Sorting is available on multiple parameters combining the parameters using & sign. The & symbol is encoded as %26 in the request. Sorting priority of the parameters depends upon the order you have added the parameters in the request while using multiple sorting. sort=attributes.FirstName
| |
order | No | Order of sorting. Applicable only in combination with the sort parameter. Possible values:
asc.Example: | |
| options | No | Comma-separated list of different options. Available options:
Example: | |
defaultMaxValues | No |
Specifies maximum number of values listed in attributes. This restriction is intended for UI convenience in the case of very long lists of values in some attributes. Example: | |
activeness | No |
Activeness is the indicator of an entity that is currently effective. The following options are available. These options are active, all, and not_active.
Example: | |
scoreEnabled | No | When set to true, documents with search hits in labels get more search relevance score. The default value is false. | |
returnAnalyticAttributes | No |
Denotes whether the analytical attributes for entities must be returned or not. If this parameter is |
Response
Returns the total number of entities that match the specified search criteria, entities grouped by the entity type, and the total number of entities by type.
Request
POST /reltio/api/<tenantId>/entities/_findConnectedParties?max=50&returnAnalyticAttributes=false
{
"filter": "equals(type,'configuration/entityTypes/Individual') and contains(attributes.Contracts.ContractNumber, 'AZH3221318002')",
"relationTypes": [
"configuration/relationTypes/ContractRoles"
],
"entityTypes": [
"configuration/entityTypes/Individual",
"configuration/entityTypes/Contract"
],
"referenceAttributesForTypes": [
"configuration/entityTypes/Contract"
]
}Response
{
"filteredTotal": 1,
"entities": {
"configuration/entityTypes/Contract": {
"total": 2,
"entities": [
{
"uri": "entities/0000EtM",
"type": "configuration/entityTypes/Contract",
"createdBy": "john.smith@reltio.com",
"createdTime": 1673585487011,
"updatedBy": "john.smith@reltio.com",
"updatedTime": 1673585710317,
"attributes": {
"ContractNumber": [
{
"type": "configuration/entityTypes/Contract/attributes/ContractNumber",
"ov": true,
"value": "AZH3221318001",
"uri": "entities/0000EtM/attributes/ContractNumber/1mt3Ym"
}
],
"CoveredParties": [
{
"label": "Sarah Smith",
"relationshipLabel": "",
"value": {
"FirstName": [
{
"type": "configuration/entityTypes/Individual/attributes/FirstName",
"ov": true,
"value": "Sarah",
"uri": "entities/0000EtM/attributes/CoveredParties/0000FxQ/FirstName/1msqm0"
}
],
"LastName": [
{
"type": "configuration/entityTypes/Individual/attributes/LastName",
"ov": true,
"value": "Smith",
"uri": "entities/0000EtM/attributes/CoveredParties/0000FxQ/LastName/1msv2G"
}
]
},
"ov": true,
"uri": "entities/0000EtM/attributes/CoveredParties/0000FxQ",
"refEntity": {
"type": "configuration/entityTypes/Individual",
"crosswalks": [
{
"uri": "entities/0000EtM/crosswalks/0000Ad6.1mszIW",
"type": "configuration/sources/AutoLeads",
"value": "Ind2000",
"createDate": "2023-01-13T04:51:27.011Z",
"updateDate": "2023-01-13T04:51:27.011Z",
"attributeURIs": [
"entities/0000EtM/attributes/CoveredParties/0000FxQ",
"entities/0000EtM/attributes/CoveredParties/0000FxQ/LastName/1msv2G",
"entities/0000EtM/attributes/CoveredParties/0000FxQ/FirstName/1msqm0"
]
}
],
"objectURI": "entities/0000Ad6"
},
"refRelation": {
"type": "configuration/relationTypes/ContractRoles",
"crosswalks": [
{
"uri": "entities/0000EtM/crosswalks/0000FxQ.1mtbeq",
"type": "configuration/sources/Reltio",
"value": "0000FxQ",
"createDate": "2023-01-13T04:55:10.317Z",
"updateDate": "2023-01-13T04:55:10.317Z"
}
],
"startRefPinned": false,
"endRefPinned": false,
"startRefIgnored": false,
"endRefIgnored": false,
"objectURI": "relations/0000FxQ"
}
},
{
"label": "John Smith",
"relationshipLabel": "",
"value": {
"FirstName": [
{
"type": "configuration/entityTypes/Individual/attributes/FirstName",
"ov": true,
"value": "John",
"uri": "entities/0000EtM/attributes/CoveredParties/00007Qu/FirstName/1msdzE"
}
],
"LastName": [
{
"type": "configuration/entityTypes/Individual/attributes/LastName",
"ov": true,
"value": "Smith",
"uri": "entities/0000EtM/attributes/CoveredParties/00007Qu/LastName/1msiFU"
}
]
},
"ov": true,
"uri": "entities/0000EtM/attributes/CoveredParties/00007Qu",
"refEntity": {
"type": "configuration/entityTypes/Individual",
"crosswalks": [
{
"uri": "entities/0000EtM/crosswalks/00006Mq.1msmVk",
"type": "configuration/sources/AutoLeads",
"value": "Ind1000",
"createDate": "2023-01-13T04:51:27.011Z",
"updateDate": "2023-01-13T04:51:27.011Z",
"attributeURIs": [
"entities/0000EtM/attributes/CoveredParties/00007Qu/LastName/1msiFU",
"entities/0000EtM/attributes/CoveredParties/00007Qu",
"entities/0000EtM/attributes/CoveredParties/00007Qu/FirstName/1msdzE"
]
}
],
"objectURI": "entities/00006Mq"
},
"refRelation": {
"type": "configuration/relationTypes/ContractRoles",
"crosswalks": [
{
"uri": "entities/0000EtM/crosswalks/00007Qu.1mtT8K",
"type": "configuration/sources/Reltio",
"value": "00007Qu",
"createDate": "2023-01-13T04:55:10.317Z",
"updateDate": "2023-01-13T04:55:10.317Z"
}
],
"startRefPinned": false,
"endRefPinned": false,
"startRefIgnored": false,
"endRefIgnored": false,
"objectURI": "relations/00007Qu"
}
}
]
},
"isFavorite": false,
"crosswalks": [
{
"uri": "entities/0000EtM/crosswalks/1mt7p2",
"type": "configuration/sources/AutoLeads",
"value": "C1",
"reltioLoadDate": "2023-01-13T04:51:27.011Z",
"createDate": "2023-01-13T04:51:27.011Z",
"updateDate": "2023-01-13T04:51:27.011Z",
"attributes": [
"entities/0000EtM/attributes/ContractNumber/1mt3Ym"
],
"singleAttributeUpdateDates": {}
}
],
"analyticsAttributes": {},
"label": "AZH3221318001",
"secondaryLabel": ""
},
{
"uri": "entities/0000J9c",
"type": "configuration/entityTypes/Contract",
"createdBy": "john.smith@reltio.com",
"createdTime": 1673585487011,
"updatedBy": "john.smith@reltio.com",
"updatedTime": 1673585710317,
"attributes": {
"ContractNumber": [
{
"type": "configuration/entityTypes/Contract/attributes/ContractNumber",
"ov": true,
"value": "AZH3221318002",
"uri": "entities/0000J9c/attributes/ContractNumber/1mtC5I"
}
],
"CoveredParties": [
{
"label": "Sarah Smith",
"relationshipLabel": "",
"value": {
"FirstName": [
{
"type": "configuration/entityTypes/Individual/attributes/FirstName",
"ov": true,
"value": "Sarah",
"uri": "entities/0000J9c/attributes/CoveredParties/0000KDg/FirstName/1msqm0"
}
],
"LastName": [
{
"type": "configuration/entityTypes/Individual/attributes/LastName",
"ov": true,
"value": "Smith",
"uri": "entities/0000J9c/attributes/CoveredParties/0000KDg/LastName/1msv2G"
}
]
},
"ov": true,
"uri": "entities/0000J9c/attributes/CoveredParties/0000KDg",
"refEntity": {
"type": "configuration/entityTypes/Individual",
"crosswalks": [
{
"uri": "entities/0000J9c/crosswalks/0000Ad6.1mszIW",
"type": "configuration/sources/AutoLeads",
"value": "Ind2000",
"createDate": "2023-01-13T04:51:27.011Z",
"updateDate": "2023-01-13T04:51:27.011Z",
"attributeURIs": [
"entities/0000J9c/attributes/CoveredParties/0000KDg",
"entities/0000J9c/attributes/CoveredParties/0000KDg/LastName/1msv2G",
"entities/0000J9c/attributes/CoveredParties/0000KDg/FirstName/1msqm0"
]
}
],
"objectURI": "entities/0000Ad6"
},
"refRelation": {
"type": "configuration/relationTypes/ContractRoles",
"crosswalks": [
{
"uri": "entities/0000J9c/crosswalks/0000KDg.1mtfv6",
"type": "configuration/sources/Reltio",
"value": "0000KDg",
"createDate": "2023-01-13T04:55:10.317Z",
"updateDate": "2023-01-13T04:55:10.317Z"
}
],
"startRefPinned": false,
"endRefPinned": false,
"startRefIgnored": false,
"endRefIgnored": false,
"objectURI": "relations/0000KDg"
}
}
]
},
"isFavorite": false,
"crosswalks": [
{
"uri": "entities/0000J9c/crosswalks/1mtGLY",
"type": "configuration/sources/AutoLeads",
"value": "C2",
"reltioLoadDate": "2023-01-13T04:51:27.011Z",
"createDate": "2023-01-13T04:51:27.011Z",
"updateDate": "2023-01-13T04:51:27.011Z",
"attributes": [
"entities/0000J9c/attributes/ContractNumber/1mtC5I"
],
"singleAttributeUpdateDates": {}
}
],
"analyticsAttributes": {},
"label": "AZH3221318002",
"secondaryLabel": ""
}
]
},
"configuration/entityTypes/Individual": {
"total": 1,
"entities": [
{
"uri": "entities/0000Ad6",
"type": "configuration/entityTypes/Individual",
"createdBy": "john.smith@reltio.com",
"createdTime": 1673585487011,
"updatedBy": "john.smith@reltio.com",
"updatedTime": 1673585487011,
"attributes": {
"FirstName": [
{
"type": "configuration/entityTypes/Individual/attributes/FirstName",
"ov": true,
"value": "Sarah",
"uri": "entities/0000Ad6/attributes/FirstName/1msqm0"
}
],
"LastName": [
{
"type": "configuration/entityTypes/Individual/attributes/LastName",
"ov": true,
"value": "Smith",
"uri": "entities/0000Ad6/attributes/LastName/1msv2G"
}
]
},
"isFavorite": false,
"crosswalks": [
{
"uri": "entities/0000Ad6/crosswalks/1mszIW",
"type": "configuration/sources/AutoLeads",
"value": "Ind2000",
"reltioLoadDate": "2023-01-13T04:51:27.011Z",
"createDate": "2023-01-13T04:51:27.011Z",
"updateDate": "2023-01-13T04:51:27.011Z",
"attributes": [
"entities/0000Ad6/attributes/LastName/1msv2G",
"entities/0000Ad6/attributes/FirstName/1msqm0"
],
"singleAttributeUpdateDates": {}
}
],
"analyticsAttributes": {},
"label": "Sarah Smith",
"secondaryLabel": ""
}
]
}
}
}
In the above response, the following parameters denote:
filteredTotal: The total number of entities that matched the specified criteria.entities: The entities grouped by the entity type.total: The total number of entities of a particular entity type.