Cognite Data Fusion API

List entity matching models

Required capabilities: entitymatchingAcl:READ

List all available entity matching models, with pagination.

Securityoidc-token or oauth2-client-credentials or oauth2-open-industrial-data or oauth2-auth-code

Request

query Parameters

cursor

string

Cursor for paging through results. In general, if a response contains a nextCursor property, it means that there may be more results, and you should pass that value as the cursor parameter in the next request.

Note that the cursor may or may not be encrypted, but either way, it is not intended to be decoded. Its internal structure is not a part of the public API, and may change without notice. You should treat it as an opaque string and not attempt to craft your own cursors.

Example: cursor=4zj0Vy2fo0NtNMb229mI9r1V3YG5NBL752kQz1cKtwo

limit

integer [ 1 .. 1000 ]

Default: 100

Limits the number of results to be returned.

Responses

200

Success

400

The response for a failed request.

get/context/entitymatching

Request samples

Python SDK
curl

client.entity_matching.list(limit=1, name="test")

Response samples

application/json

{"items": [{"id": 1,
"externalId": "my.known.id",
"status": "Queued",
"createdTime": 1730204346000,
"startTime": 1730204346000,
"statusTime": 1730204346000,
"errorMessage": null,
"name": "simple_model_1",
"description": "Simple model 1",
"featureType": "simple",
"matchFields": [{"source": "name",
"target": "name"
},
{"source": "name",
"target": "someField"
}
],
"ignoreMissingFields": true,
"classifier": "randomforest",
"originalId": 111
}
],
"nextCursor": "string"
}

➔ Next to Predict matches