Run an advanced join

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.
Securityoidc-token or oauth2-client-credentials or oauth2-open-industrial-data or oauth2-auth-code
Request
Request Body schema: application/json
advancedJoinExternalId
required
string (CogniteExternalId) <= 255 characters

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

Responses
200

The resulting advanced join job.

400

The response for a bad request.

429

The response for too many requests (concurrency or rate throttling).

post/advancedjoins/run
Request samples
application/json
{
  • "advancedJoinExternalId": "my.known.id"
}
Response samples
application/json
{
  • "jobId": "string",
  • "status": "Queued",
  • "createdTime": 1730204346000,
  • "startTime": 1730204346000,
  • "statusTime": 1730204346000,
  • "errorMessage": null,
  • "advancedJoinExternalId": "my.known.id"
}
➔ Next to Suggest improvements