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 GET \
--url https://{cluster}.cognitedata.com/api/v1/projects/{project}/advancedjoins \
--header 'Authorization: Bearer <token>'{
"items": [
{
"externalId": "my.known.id",
"type": "direct",
"space": "<string>",
"viewExternalId": "<string>",
"viewVersion": "<string>",
"propertyName": "<string>",
"matchers": [
{
"type": "raw",
"dbName": "<string>",
"tableName": "<string>",
"fromColumnKey": "<string>",
"toColumnKey": "<string>"
}
]
}
],
"nextCursor": "<string>"
}Required capabilities:
entitymatchingAcl:READ
List advanced join objects.
You can use the query parameters to add filters to the query.
curl --request GET \
--url https://{cluster}.cognitedata.com/api/v1/projects/{project}/advancedjoins \
--header 'Authorization: Bearer <token>'{
"items": [
{
"externalId": "my.known.id",
"type": "direct",
"space": "<string>",
"viewExternalId": "<string>",
"viewVersion": "<string>",
"propertyName": "<string>",
"matchers": [
{
"type": "raw",
"dbName": "<string>",
"tableName": "<string>",
"fromColumnKey": "<string>",
"toColumnKey": "<string>"
}
]
}
],
"nextCursor": "<string>"
}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.
Query Parameters
Limits the number of results to be returned. The maximum results returned by the server is 1000 even if you specify a higher limit.
1 <= x <= 1000Cursor 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"
1 - 43^[a-zA-Z][a-zA-Z0-9_-]{0,41}[a-zA-Z0-9]?$1 - 255^[a-zA-Z]([a-zA-Z0-9_]{0,253}[a-zA-Z0-9])?$1 - 43^[a-zA-Z0-9]([.a-zA-Z0-9_-]{0,41}[a-zA-Z0-9])?$Was this page helpful?