Execute a entity resolution preview for a given set of data (resolution properties) and identifiers

curl --request POST \
  --url https://api.{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>"
      }
    }
  ]
}
'

import requests

url = "https://api.{workspaceId}.clinia.cloud/mdm/v1/collections/{collectionKey}/entity-resolution/preview"

payload = {
    "data": {},
    "identifier": [
        {
            "id": "<string>",
            "system": "<string>",
            "value": "<string>",
            "use": "<string>",
            "period": {
                "id": "<string>",
                "start": "<string>",
                "end": "<string>"
            }
        }
    ]
}
headers = {
    "X-Clinia-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-Clinia-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    data: {},
    identifier: [
      {
        id: '<string>',
        system: '<string>',
        value: '<string>',
        use: '<string>',
        period: {id: '<string>', start: '<string>', end: '<string>'}
      }
    ]
  })
};

fetch('https://api.{workspaceId}.clinia.cloud/mdm/v1/collections/{collectionKey}/entity-resolution/preview', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.{workspaceId}.clinia.cloud/mdm/v1/collections/{collectionKey}/entity-resolution/preview",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'data' => [
        
    ],
    'identifier' => [
        [
                'id' => '<string>',
                'system' => '<string>',
                'value' => '<string>',
                'use' => '<string>',
                'period' => [
                                'id' => '<string>',
                                'start' => '<string>',
                                'end' => '<string>'
                ]
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-Clinia-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.{workspaceId}.clinia.cloud/mdm/v1/collections/{collectionKey}/entity-resolution/preview"

	payload := strings.NewReader("{\n  \"data\": {},\n  \"identifier\": [\n    {\n      \"id\": \"<string>\",\n      \"system\": \"<string>\",\n      \"value\": \"<string>\",\n      \"use\": \"<string>\",\n      \"period\": {\n        \"id\": \"<string>\",\n        \"start\": \"<string>\",\n        \"end\": \"<string>\"\n      }\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-Clinia-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.{workspaceId}.clinia.cloud/mdm/v1/collections/{collectionKey}/entity-resolution/preview")
  .header("X-Clinia-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"data\": {},\n  \"identifier\": [\n    {\n      \"id\": \"<string>\",\n      \"system\": \"<string>\",\n      \"value\": \"<string>\",\n      \"use\": \"<string>\",\n      \"period\": {\n        \"id\": \"<string>\",\n        \"start\": \"<string>\",\n        \"end\": \"<string>\"\n      }\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.{workspaceId}.clinia.cloud/mdm/v1/collections/{collectionKey}/entity-resolution/preview")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-Clinia-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"data\": {},\n  \"identifier\": [\n    {\n      \"id\": \"<string>\",\n      \"system\": \"<string>\",\n      \"value\": \"<string>\",\n      \"use\": \"<string>\",\n      \"period\": {\n        \"id\": \"<string>\",\n        \"start\": \"<string>\",\n        \"end\": \"<string>\"\n      }\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "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"
    }
  ]
}

{
  "message": "<string>",
  "details": "<array>",
  "additionalContext": {}
}

{
  "message": "<string>",
  "details": "<array>",
  "additionalContext": {}
}

{
  "message": "<string>",
  "details": "<array>",
  "additionalContext": {}
}

{
  "message": "<string>",
  "details": "<array>",
  "additionalContext": {}
}

{
  "message": "<string>",
  "details": "<array>",
  "additionalContext": {}
}

Collections

Execute a entity resolution preview for a given set of data (resolution properties) and identifiers

This endpoint allows you to preview/simulate the outcome of the entity resolution process for the given collection. It returns a list of hits/matches to unified records in the system based the resolution rule of the collection, using the provided data and identifiers. Use this endpoint to understand how the entity resolution process would behave when injecting a record into the collection, helping you to understand the result on the system.

Note: Entity resolution first checks for duplicate identifiers already present in the system (unified records) and then applies the resolution rule to find matches. Therefore if matches are found based on identifiers, the resolution properties are ignored.

POST

mdm

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://api.{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>"
      }
    }
  ]
}
'

import requests

url = "https://api.{workspaceId}.clinia.cloud/mdm/v1/collections/{collectionKey}/entity-resolution/preview"

payload = {
    "data": {},
    "identifier": [
        {
            "id": "<string>",
            "system": "<string>",
            "value": "<string>",
            "use": "<string>",
            "period": {
                "id": "<string>",
                "start": "<string>",
                "end": "<string>"
            }
        }
    ]
}
headers = {
    "X-Clinia-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-Clinia-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    data: {},
    identifier: [
      {
        id: '<string>',
        system: '<string>',
        value: '<string>',
        use: '<string>',
        period: {id: '<string>', start: '<string>', end: '<string>'}
      }
    ]
  })
};

fetch('https://api.{workspaceId}.clinia.cloud/mdm/v1/collections/{collectionKey}/entity-resolution/preview', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.{workspaceId}.clinia.cloud/mdm/v1/collections/{collectionKey}/entity-resolution/preview",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'data' => [
        
    ],
    'identifier' => [
        [
                'id' => '<string>',
                'system' => '<string>',
                'value' => '<string>',
                'use' => '<string>',
                'period' => [
                                'id' => '<string>',
                                'start' => '<string>',
                                'end' => '<string>'
                ]
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-Clinia-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.{workspaceId}.clinia.cloud/mdm/v1/collections/{collectionKey}/entity-resolution/preview"

	payload := strings.NewReader("{\n  \"data\": {},\n  \"identifier\": [\n    {\n      \"id\": \"<string>\",\n      \"system\": \"<string>\",\n      \"value\": \"<string>\",\n      \"use\": \"<string>\",\n      \"period\": {\n        \"id\": \"<string>\",\n        \"start\": \"<string>\",\n        \"end\": \"<string>\"\n      }\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-Clinia-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.{workspaceId}.clinia.cloud/mdm/v1/collections/{collectionKey}/entity-resolution/preview")
  .header("X-Clinia-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"data\": {},\n  \"identifier\": [\n    {\n      \"id\": \"<string>\",\n      \"system\": \"<string>\",\n      \"value\": \"<string>\",\n      \"use\": \"<string>\",\n      \"period\": {\n        \"id\": \"<string>\",\n        \"start\": \"<string>\",\n        \"end\": \"<string>\"\n      }\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.{workspaceId}.clinia.cloud/mdm/v1/collections/{collectionKey}/entity-resolution/preview")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-Clinia-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"data\": {},\n  \"identifier\": [\n    {\n      \"id\": \"<string>\",\n      \"system\": \"<string>\",\n      \"value\": \"<string>\",\n      \"use\": \"<string>\",\n      \"period\": {\n        \"id\": \"<string>\",\n        \"start\": \"<string>\",\n        \"end\": \"<string>\"\n      }\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "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"
    }
  ]
}

{
  "message": "<string>",
  "details": "<array>",
  "additionalContext": {}
}

{
  "message": "<string>",
  "details": "<array>",
  "additionalContext": {}
}

{
  "message": "<string>",
  "details": "<array>",
  "additionalContext": {}
}

{
  "message": "<string>",
  "details": "<array>",
  "additionalContext": {}
}

{
  "message": "<string>",
  "details": "<array>",
  "additionalContext": {}
}

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 source identifiers in the format source:<>:<>.

Show child attributes

Response

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

Option 1
Option 2

type

enum<string>

required

Available options:

IDENTIFIER,

RESOLUTION_PROPERTY

hits

object[]

required

Show child attributes

Get the collection profile Retrieve a unified resource from mdm collection using its id

⌘I

Data Catalog Endpoints

Data Partition Endpoints

MDM Endpoints

Registry Endpoints

Terminology Endpoints

Operations Endpoints

AI Engine

Execute a entity resolution preview for a given set of data (resolution properties) and identifiers

Authorizations

Path Parameters

Body

Response