Skip to main content
POST
/
mdm
/
v1
/
collections
/
{collectionKey}
/
entity-resolution
/
preview
Execute a entity resolution preview for a given set of data (resolution properties) and identifiers
curl --request POST \
  --url https://{workspaceId}.clinia.cloud/mdm/v1/collections/{collectionKey}/entity-resolution/preview \
  --header 'Content-Type: application/json' \
  --header 'X-Clinia-API-Key: <api-key>' \
  --data '
{
  "data": {},
  "identifier": [
    {
      "id": "<string>",
      "system": "<string>",
      "value": "<string>",
      "use": "<string>",
      "period": {
        "id": "<string>",
        "start": "<string>",
        "end": "<string>"
      }
    }
  ]
}
'
{
  "type": "IDENTIFIER",
  "hits": [
    {
      "to": "<string>",
      "matches": [
        {
          "source": "<string>",
          "id": "<string>",
          "identifier": {
            "id": "<string>",
            "system": "<string>",
            "value": "<string>",
            "use": "<string>",
            "period": {
              "id": "<string>",
              "start": "<string>",
              "end": "<string>"
            }
          }
        }
      ],
      "type": "MATCH_TYPE_MATCH"
    }
  ]
}

Authorizations

​
X-Clinia-API-Key
string
header
required

Path Parameters

​
collectionKey
string
required

Key of the collection.

Body

application/json
​
data
object
required

The data used in the resolution preview. It contains properties which must match the resolution properties defined in the resolution rule of the unified collection Note: The data must be a valid JSON object and values must be defined as arrays.

​
identifier
object[]

Identifiers used in the resolution preview. If any of those identifiers are used by a source record linked to a unified record in the system, the resolution preview will return the unified record as an exact match. Note: identifier match are done at the source record level, so it doesn't include generated relative identities or source identifiers in the format source:<>:<>.

Response

A successful response. The response contains the list of hits/matches to unified records.

​
type
enum<string>
required
Available options:
IDENTIFIER,
RESOLUTION_PROPERTY
​
hits
object[]
required