New: build custom CDF applications with Cognite Flows. Documentation · What's new.
curl --request POST \
--url https://{cluster}.cognitedata.com/api/v1/projects/{project}/context/entitymatching/pipelines/byids \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"items": [
{
"externalId": "my.known.id"
}
]
}
'{
"items": [
{
"id": 4503599627370496,
"createdTime": 1730204346000,
"sources": {
"dataSetIds": [
{
"externalId": "my.known.id"
}
],
"resource": "assets"
},
"targets": {
"dataSetIds": [
{
"externalId": "my.known.id"
}
],
"resource": "assets"
},
"lastUpdatedTime": 1730204346000,
"owner": "alice@example.com",
"externalId": "my.known.id",
"name": "myPipeline",
"description": "My pipeline",
"modelParameters": {
"featureType": "bigram"
},
"trueMatches": [
{
"sourceId": 23,
"targetExternalId": "my.known.id"
}
],
"confirmedMatches": [
{
"sourceId": 23,
"targetExternalId": "my.known.id"
}
],
"rejectedMatches": [
{
"sourceId": 23,
"targetExternalId": "my.known.id"
}
],
"useExistingMatches": false,
"generateRules": true,
"replacements": [
{
"field": "*",
"string": "Bottom-hole pressure",
"replacement": "bhp"
}
],
"rules": [],
"rejectedRules": [],
"scoreThreshold": 0.7,
"scheduleInterval": 7200,
"lastRun": {
"status": "Queued",
"createdTime": 1730204346000,
"startTime": 1730204346000,
"statusTime": 1730204346000,
"jobId": 123,
"errorMessage": null
}
}
]
}Required capabilities:
entitymatchingAcl:READassetsAcl:READ
Retrieve multiple entity matching pipelines.
curl --request POST \
--url https://{cluster}.cognitedata.com/api/v1/projects/{project}/context/entitymatching/pipelines/byids \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"items": [
{
"externalId": "my.known.id"
}
]
}
'{
"items": [
{
"id": 4503599627370496,
"createdTime": 1730204346000,
"sources": {
"dataSetIds": [
{
"externalId": "my.known.id"
}
],
"resource": "assets"
},
"targets": {
"dataSetIds": [
{
"externalId": "my.known.id"
}
],
"resource": "assets"
},
"lastUpdatedTime": 1730204346000,
"owner": "alice@example.com",
"externalId": "my.known.id",
"name": "myPipeline",
"description": "My pipeline",
"modelParameters": {
"featureType": "bigram"
},
"trueMatches": [
{
"sourceId": 23,
"targetExternalId": "my.known.id"
}
],
"confirmedMatches": [
{
"sourceId": 23,
"targetExternalId": "my.known.id"
}
],
"rejectedMatches": [
{
"sourceId": 23,
"targetExternalId": "my.known.id"
}
],
"useExistingMatches": false,
"generateRules": true,
"replacements": [
{
"field": "*",
"string": "Bottom-hole pressure",
"replacement": "bhp"
}
],
"rules": [],
"rejectedRules": [],
"scoreThreshold": 0.7,
"scheduleInterval": 7200,
"lastRun": {
"status": "Queued",
"createdTime": 1730204346000,
"startTime": 1730204346000,
"statusTime": 1730204346000,
"jobId": 123,
"errorMessage": null
}
}
]
}Documentation Index
Fetch the complete documentation index at: https://docs.cognite.com/llms.txt
Use this file to discover all available pages before exploring further.
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.
Pipeline identifiers
1 - 100 elementsEither an internal ID, or an external ID.
Show child attributes
{ "externalId": "my.known.id" }List of pipelines
Show child attributes
Was this page helpful?