Skip to main content
POST
/
context
/
entitymatching
/
list
JavaScript SDK
const { items } = await client.entityMatching.list({ filter: { name: 'model123' }});
curl --request POST \
--url https://{cluster}.cognitedata.com/api/v1/projects/{project}/context/entitymatching/list \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"filter": {
"featureType": "simple",
"classifier": "randomforest",
"originalId": 111,
"name": "simple_model_1",
"description": "Simple model 1"
},
"limit": 100
}
'
import requests

url = "https://{cluster}.cognitedata.com/api/v1/projects/{project}/context/entitymatching/list"

payload = {
"filter": {
"featureType": "simple",
"classifier": "randomforest",
"originalId": 111,
"name": "simple_model_1",
"description": "Simple model 1"
},
"limit": 100
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

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

print(response.text)
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://{cluster}.cognitedata.com/api/v1/projects/{project}/context/entitymatching/list",
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([
'filter' => [
'featureType' => 'simple',
'classifier' => 'randomforest',
'originalId' => 111,
'name' => 'simple_model_1',
'description' => 'Simple model 1'
],
'limit' => 100
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);

$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://{cluster}.cognitedata.com/api/v1/projects/{project}/context/entitymatching/list"

payload := strings.NewReader("{\n \"filter\": {\n \"featureType\": \"simple\",\n \"classifier\": \"randomforest\",\n \"originalId\": 111,\n \"name\": \"simple_model_1\",\n \"description\": \"Simple model 1\"\n },\n \"limit\": 100\n}")

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

req.Header.Add("Authorization", "Bearer <token>")
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://{cluster}.cognitedata.com/api/v1/projects/{project}/context/entitymatching/list")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"filter\": {\n \"featureType\": \"simple\",\n \"classifier\": \"randomforest\",\n \"originalId\": 111,\n \"name\": \"simple_model_1\",\n \"description\": \"Simple model 1\"\n },\n \"limit\": 100\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://{cluster}.cognitedata.com/api/v1/projects/{project}/context/entitymatching/list")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"filter\": {\n \"featureType\": \"simple\",\n \"classifier\": \"randomforest\",\n \"originalId\": 111,\n \"name\": \"simple_model_1\",\n \"description\": \"Simple model 1\"\n },\n \"limit\": 100\n}"

response = http.request(request)
puts response.read_body
{
  "items": [
    {
      "id": 4503599627370496,
      "externalId": "my.known.id",
      "createdTime": 1730204346000,
      "startTime": 1730204346000,
      "statusTime": 1730204346000,
      "name": "simple_model_1",
      "description": "Simple model 1",
      "errorMessage": null,
      "featureType": "simple",
      "matchFields": [
        {
          "source": "name",
          "target": "name"
        },
        {
          "source": "name",
          "target": "someField"
        }
      ],
      "ignoreMissingFields": true,
      "classifier": "randomforest",
      "originalId": 111
    }
  ]
}
{
"error": {
"code": 401,
"message": "Could not authenticate.",
"missing": [
{}
],
"duplicated": [
{}
]
}
}

Authorizations

Authorization
string
header
required

Access token issued by the CDF project's configured identity provider. Access token must be an OpenID Connect token, and the project must be configured to accept OpenID Connect tokens. Use a header key of 'Authorization' with a value of 'Bearer $accesstoken'. The token can be obtained through any flow supported by the identity provider.

Body

application/json
filter
object
required

Filter on models with strict matching.

limit
integer<int32>
default:100

<- Limits the number of results to return.

Required range: 1 <= x <= 1000

Response

Success

items
object[]
required
Last modified on July 10, 2026