Skip to main content
GET
/
context
/
entitymatching
/
pipelines
/
{pipelineId}
Get pipeline
curl --request GET \
  --url https://{cluster}.cognitedata.com/api/v1/projects/{project}/context/entitymatching/pipelines/{pipelineId} \
  --header 'Authorization: Bearer <token>'
{
  "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
  }
}

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.

Path Parameters

​
pipelineId
integer<int64>
required

A server-generated ID for the object.

Required range: 1 <= x <= 9007199254740991

Response

Single pipeline

Pipeline to create

​
id
integer<int64>
required

A server-generated ID for the object.

Required range: 1 <= x <= 9007199254740991
​
createdTime
integer<int64>
required

The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.

Required range: x >= 0
Example:

1730204346000

​
sources
object
required

Source of the pipeline

​
targets
object
required

Target a dataset

​
lastUpdatedTime
integer<int64>

The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.

Required range: x >= 0
Example:

1730204346000

​
owner
string

Owner of the pipeline. This is only provided in case the pipeline was created in the Fusion front-end.

Example:

"alice@example.com"

​
externalId
string

The external ID provided by the client. Must be unique for the resource type.

Maximum string length: 255
Example:

"my.known.id"

​
name
string

User-defined name of the pipeline.

Maximum string length: 256
Example:

"myPipeline"

​
description
string

User-defined description of the pipeline.

Maximum string length: 500
Example:

"My pipeline"

​
modelParameters
object

The parameters to use in the entity matching model.

Example:
{ "featureType": "bigram" }
​
trueMatches
object[]

A list of confirmed source/target matches, which will be used to train the model. If omitted, an unsupervised model is trained.

Required array length: 1 - 2000000 elements

A pair of source ID and target ID, that indicates a match between two entities in the source and target spaces. Internal and external IDs are supported.

Example:
{
  "sourceId": 23,
  "targetExternalId": "my.known.id"
}
​
confirmedMatches
object[]

List of objects of pairs of sourceId or sourceExternalId and targetId or targetExternalId, that corresponds to entities in source and target respectively, that indicates a confirmed match by the user. A source and target pair in this list will override results from a model or rules and will therefore always be returned as a match. The matches are also used as training data when the entity matcher model is created.

A pair of source ID and target ID, that indicates a match between two entities in the source and target spaces. Internal and external IDs are supported.

Example:
{
  "sourceId": 23,
  "targetExternalId": "my.known.id"
}
​
rejectedMatches
object[]

List of objects of pairs of sourceId or sourceExternalId and targetId or targetExternalId, that corresponds to entities in source and target respectively, that indicates a match rejected by the user. A source and target pair in this list will override results from a model or rules and will never be returned as a match.

A pair of source ID and target ID, that indicates a match between two entities in the source and target spaces. Internal and external IDs are supported.

Example:
{
  "sourceId": 23,
  "targetExternalId": "my.known.id"
}
​
useExistingMatches
boolean | null
default:false

Use existing (id/assetId) links on the CDF resources as training data when the entity matching model is created.

​
generateRules
boolean | null
default:true

Whether to generate match rules automatically

​
replacements
object[]

Replace strings in entity fields. You can use this field to add input naming variations to the entity matching model to improve the suggested matches, for example, 'pmp' for 'pump' and 'bhp' for 'bottom hole pressure'. To avoid false positives, we recommend using the longer string as string and the shorter as replacement.

​
rules
object[]

A collection of match rules

Maximum array length: 1000
​
rejectedRules
object[]

A collection of match rules

Maximum array length: 1000
​
scoreThreshold
number
default:0

Only return model matches with score above this threshold.

Required range: 0 <= x <= 1
Example:

0.7

​
scheduleInterval
integer

How often to schedule the pipeline, in seconds. The interval can be between 1 hour and 31 days.

Required range: 3600 <= x <= 2678400
Example:

7200

​
lastRun
object

The latest run for this pipeline, if it was ever run.

Last modified on April 23, 2026