How to search on entities by attributes using the Search API?

Question

How to perform an Entity search via API and apply different types of filters to the search?

Answer

Reltio provides a robust Search API that allows for customized entity searches using a variety of filter conditions. The general syntax for applying filters is:

filter=({Condition Type}[AND/OR {Condition Type}]*)

Here are the supported filter condition types:docs.reltio.com+2docs.reltio.com+2docs.reltio.com+2

• equals(property, value): Performs an exact match, ignoring case.
  Example: equals(attributes.LastName, 'Smith')support.reltio.com
• not equals(property, value): Matches entities where the property does not equal the specified value, ignoring case.
  Example: not equals(attributes.Status, 'Inactive')docs.reltio.com
• equalsCaseSensitive(property, value): Performs an exact match, considering case.
  Example: equalsCaseSensitive(attributes.FirstName, 'John')
• containsWordStartingWith(property, value): Finds entities where the specified property contains a word starting with the given value.
  Example: containsWordStartingWith(attributes.Title, 'Manag')docs.reltio.com
• startsWith(property, value): Finds entities where the specified property starts with the given value.
  Example: startsWith(attributes.Email, 'info@')community.reltio.com+4support.reltio.com+4docs.reltio.com+4
• fullText(property, value): Performs a full-text search on the specified property.
  Example: fullText(attributes.Description, 'healthcare')docs.reltio.com
• missing(property): Finds entities where the specified property is missing or has no value.
  Example: missing(attributes.PhoneNumber)
• exists(property): Finds entities where the specified property exists and has a value.
  Example: exists(attributes.Address)
• inSameAttributeValue(subquery): Finds entities that have all attributes matching a subquery within a single nested or reference attribute.
  Example: inSameAttributeValue(equals(attributes.Address.City, 'Chicago') and equals(attributes.Address.State, 'IL'))docs.reltio.com
• insideCategoryTree(category, '<category URI>'): Filters entities that belong to a specified category or any of its child categories.
  Example: insideCategoryTree(categories, 'categories/000777')docs.reltio.com
• listEquals(property, value1, value2, ...): Finds entities where the specified property matches any of the provided values.
  Example: listEquals(attributes.Department, 'Sales', 'Marketing')
• listEquals(property, 'URL:<file URI>'): Finds entities where the specified property matches any value from a provided file (TXT or CSV format).
  Example: listEquals(attributes.EmployeeID, 'URL:https://example.com/employee_ids.txt')

Example API Request

To search for entities of type 'HCP' from the 'PBMD' source system with the last name 'Hughes' and name initials 'D':

GET https://<environment>.reltio.com/reltio/api/<tenantID>/entities/_total?filter=equals(type,'configuration/entityTypes/HCP') and equals(sourceSystems,'PBMD') and equals(attributes.LastName,'Hughes') and equals(attributes.NameInitials,'D')

References

• Filtering Entities
• Search API