API reference (20230101-alpha)
- Overview
- GETList advanced joins
- GETRetrieve estimate quality status
- GETList matches
- GETRetrieve mapped percentage status
- GETRetrieve advanced join run status
- GETRetrieve suggested improvements
- POSTCreate advanced joins
- POSTDelete advanced joins
- POSTEstimate contextualization quality
- POSTCreate matches
- POSTDelete matches
- POSTMeasure mapped percentages
- POSTRun an advanced join
- POSTSuggest improvements
- POSTUpdate advanced joins
curl --request POST \
--url https://{cluster}.cognitedata.com/api/v1/projects/{project}/advancedjoins/run \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"advancedJoinExternalId": "my.known.id"
}
'{
"jobId": "<string>",
"status": "Queued",
"createdTime": 1730204346000,
"startTime": 1730204346000,
"statusTime": 1730204346000,
"advancedJoinExternalId": "my.known.id",
"errorMessage": null
}Run an advanced join
Required capabilities:
entitymatchingAcl:WRITE
Run an advanced join, which populates the original instances’ direct relation property with the best combination of matcher results and matches.
The caller needs to have:
- write access to the view they are querying, and
- read access to the Raw table the matcher is pointing to.
curl --request POST \
--url https://{cluster}.cognitedata.com/api/v1/projects/{project}/advancedjoins/run \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"advancedJoinExternalId": "my.known.id"
}
'{
"jobId": "<string>",
"status": "Queued",
"createdTime": 1730204346000,
"startTime": 1730204346000,
"statusTime": 1730204346000,
"advancedJoinExternalId": "my.known.id",
"errorMessage": null
}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.
Body
The external ID provided by the client. Must be unique for the resource type.
255"my.known.id"
Response
The resulting advanced join job.
ID of an advanced join job. These are always UUIDs.
The status of the job.
Queued, Running, Completed, Failed The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
x >= 01730204346000
The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
x >= 01730204346000
The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
x >= 01730204346000
The external ID provided by the client. Must be unique for the resource type.
255"my.known.id"
If the job failed, some more information about the error cause.
null
Was this page helpful?