Get Entity with Reltio Lightspeed

Learn about the Predicate Query API (Reltio Lightspeed) operation to retrieve data records.

Note: Reltio Lightspeed is only available on Amazon Web Services (AWS) and Google Cloud Platform (GCP).

Important: Before you begin, ensure:

You have READ privileges for the MDM.Data.Entities.Profile resource and ROLE_API Access permissions.
Attributes / Entity / Crosswalks are indexed in the tenant configuration.

Reltio Lightspeed (Predicate API) Context

This operation enables you to retrieve records by specifying attribute values, entity uri or crosswalk details, directly querying indexed data while bypassing broader search methods for improved performance.

Request

POST /api/{tenant}/entities/_predicateQuery

Headers: Provides information about authentication access token in the format "Bearer <accessToken>". For more information, see Authentication API.Authentication: Bearer <token>

Table 1. Body parameters
Parameter	Type	Description
queryType	String	Specifies the type of query (along with the corresponding object): attribute crosswalk uri
attribute	Object	Specifies the attribute details for the query: name - the attribute name to query by; for subnested attributes, use <nestedName>.<subNestedName> value - the attribute value to query by
crosswalk	Object	Specifies the crosswalk details for the query: type - the crosswalk type value - the crosswalk value sourceTable - the source table associated with the crosswalk
uri	String	Contains the object uri, when querying by this parameter.
metadataTypes	List	Specifies the metadata types to be queried (optional); if absent, all indexed types are required.

Request body structure - Attribute

{
  "queryType": "attribute",
  "attribute": {
    "name": "string",
    "value": {}
  },
  "metadataTypes": [
    "string"
  ]
}

Request body structure - Crosswalk

{
  "queryType": "crosswalk",
  "crosswalk": {
    "type": "string",
    "value": "string",
    "sourceTable": "string"
  },
  "metadataTypes": [
    "string"
  ]
}

Request body structure - URI

{
  "queryType": "uri",
  "uri": "string",
  "metadataTypes": [
    "string"
  ]

Response

The response is a list of entities in Reltio standard JSON format.

Example

Request body example: This example demonstrates how to request a record by specifying the passportNumber attribute and its value.{ "queryType": "attribute", "attribute": { "name": "passportNumber", "value": "123456789" } "metadataTypes": [ "configuration/entityTypes/Person" ] }
Response example: [ { "uri": "entities/01xyz123", "type": "configuration/entityTypes/Person", "createdBy": "api.user", "createdTime": 1697827200000, "updatedBy": "api.user", "updatedTime": 1697827200000, "attributes": { "passportNumber": [ { "type": "configuration/entityTypes/Person/attributes/passportNumber", "ov": true, "value": "123456789", "uri": "entities/01xyz123/attributes/passportNumber/abc123" } ], "FirstName": [ { "type": "configuration/entityTypes/Person/attributes/FirstName", "ov": true, "value": "John", "uri": "entities/01xyz123/attributes/FirstName/de456" }], "LastName": [ { "type": "configuration/entityTypes/Person/attributes/LastName", "ov": true, "value": "Doe", "uri": "entities/01xyz123/attributes/LastName/gh789" } ], "dob": [ { "type": "configuration/entityTypes/Person/attributes/dob", "ov": true, "value": "1990-01-01", "uri": "entities/01xyz123/attributes/dob/jkl012" } ] }, "isFavorite": false, "crosswalks": [ { ... ], "label": "John Doe", "secondaryLabel": "1990-01-01" } ]

You've found your way to a temporary environment. Content is not complete or final. Looking for Reltio documentation? Go to docs.reltio.com.

Unify and manage your data