API reference (20230101-alpha)
- Overview
- Overview
- POSTCreate entity matcher model
- POSTDelete entity matcher model
- POSTFilter models
- GETList entity matching models
- GETRetrieve an entity matching model by the ID of the model
- POSTPredict matches
- POSTRe-fit entity matcher model
- GETRetrieve entity matcher predict results
- POSTRetrieve entity matching models
- POSTUpdate entity matching models
curl --request GET \
--url https://{cluster}.cognitedata.com/api/v1/projects/{project}/context/entitymatching/pipelines/{pipelineId}/runs \
--header 'Authorization: Bearer <token>'{
"items": [
{
"status": "Queued",
"createdTime": 1730204346000,
"startTime": 1730204346000,
"statusTime": 1730204346000,
"jobId": 123,
"errorMessage": null
}
],
"nextCursor": "4zj0Vy2fo0NtNMb229mI9r1V3YG5NBL752kQz1cKtwo"
}List pipeline runs
Required capabilities:
entitymatchingAcl:READassetsAcl:READ
List runs for an entity matching pipeline.
This endpoint returns run summaries. If you want to get the complete results for a single run, use the run results get endpoint.
curl --request GET \
--url https://{cluster}.cognitedata.com/api/v1/projects/{project}/context/entitymatching/pipelines/{pipelineId}/runs \
--header 'Authorization: Bearer <token>'{
"items": [
{
"status": "Queued",
"createdTime": 1730204346000,
"startTime": 1730204346000,
"statusTime": 1730204346000,
"jobId": 123,
"errorMessage": null
}
],
"nextCursor": "4zj0Vy2fo0NtNMb229mI9r1V3YG5NBL752kQz1cKtwo"
}Authorizations
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
A server-generated ID for the object.
1 <= x <= 9007199254740991Query Parameters
Limits the number of results to be returned. The maximum results returned by the server is 100, even if you specify a higher limit.
1 <= x <= 100Cursor 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.
"4zj0Vy2fo0NtNMb229mI9r1V3YG5NBL752kQz1cKtwo"
Response
List of pipeline runs
Was this page helpful?