Update advanced joins
curl --request POST \
--url https://{cluster}.cognitedata.com/api/v1/projects/{project}/advancedjoins/update \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"items": [
{
"externalId": "my.known.id",
"update": {
"matchers": {
"set": [
{
"type": "raw",
"dbName": "<string>",
"tableName": "<string>",
"fromColumnKey": "<string>",
"toColumnKey": "<string>"
}
]
}
}
}
]
}
'import requests
url = "https://{cluster}.cognitedata.com/api/v1/projects/{project}/advancedjoins/update"
payload = { "items": [
{
"externalId": "my.known.id",
"update": { "matchers": { "set": [
{
"type": "raw",
"dbName": "<string>",
"tableName": "<string>",
"fromColumnKey": "<string>",
"toColumnKey": "<string>"
}
] } }
}
] }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
items: [
{
externalId: 'my.known.id',
update: {
matchers: {
set: [
{
type: 'raw',
dbName: '<string>',
tableName: '<string>',
fromColumnKey: '<string>',
toColumnKey: '<string>'
}
]
}
}
}
]
})
};
fetch('https://{cluster}.cognitedata.com/api/v1/projects/{project}/advancedjoins/update', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{cluster}.cognitedata.com/api/v1/projects/{project}/advancedjoins/update",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'items' => [
[
'externalId' => 'my.known.id',
'update' => [
'matchers' => [
'set' => [
[
'type' => 'raw',
'dbName' => '<string>',
'tableName' => '<string>',
'fromColumnKey' => '<string>',
'toColumnKey' => '<string>'
]
]
]
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{cluster}.cognitedata.com/api/v1/projects/{project}/advancedjoins/update"
payload := strings.NewReader("{\n \"items\": [\n {\n \"externalId\": \"my.known.id\",\n \"update\": {\n \"matchers\": {\n \"set\": [\n {\n \"type\": \"raw\",\n \"dbName\": \"<string>\",\n \"tableName\": \"<string>\",\n \"fromColumnKey\": \"<string>\",\n \"toColumnKey\": \"<string>\"\n }\n ]\n }\n }\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://{cluster}.cognitedata.com/api/v1/projects/{project}/advancedjoins/update")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"items\": [\n {\n \"externalId\": \"my.known.id\",\n \"update\": {\n \"matchers\": {\n \"set\": [\n {\n \"type\": \"raw\",\n \"dbName\": \"<string>\",\n \"tableName\": \"<string>\",\n \"fromColumnKey\": \"<string>\",\n \"toColumnKey\": \"<string>\"\n }\n ]\n }\n }\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{cluster}.cognitedata.com/api/v1/projects/{project}/advancedjoins/update")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"items\": [\n {\n \"externalId\": \"my.known.id\",\n \"update\": {\n \"matchers\": {\n \"set\": [\n {\n \"type\": \"raw\",\n \"dbName\": \"<string>\",\n \"tableName\": \"<string>\",\n \"fromColumnKey\": \"<string>\",\n \"toColumnKey\": \"<string>\"\n }\n ]\n }\n }\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"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>"
}
]
}
]
}{
"error": {
"code": 400,
"message": "`null` values aren't allowed."
}
}Update advanced joins
Required capabilities:
entitymatchingAcl:WRITE
Update advanced join objects.
POST
/
advancedjoins
/
update
Update advanced joins
curl --request POST \
--url https://{cluster}.cognitedata.com/api/v1/projects/{project}/advancedjoins/update \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"items": [
{
"externalId": "my.known.id",
"update": {
"matchers": {
"set": [
{
"type": "raw",
"dbName": "<string>",
"tableName": "<string>",
"fromColumnKey": "<string>",
"toColumnKey": "<string>"
}
]
}
}
}
]
}
'import requests
url = "https://{cluster}.cognitedata.com/api/v1/projects/{project}/advancedjoins/update"
payload = { "items": [
{
"externalId": "my.known.id",
"update": { "matchers": { "set": [
{
"type": "raw",
"dbName": "<string>",
"tableName": "<string>",
"fromColumnKey": "<string>",
"toColumnKey": "<string>"
}
] } }
}
] }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
items: [
{
externalId: 'my.known.id',
update: {
matchers: {
set: [
{
type: 'raw',
dbName: '<string>',
tableName: '<string>',
fromColumnKey: '<string>',
toColumnKey: '<string>'
}
]
}
}
}
]
})
};
fetch('https://{cluster}.cognitedata.com/api/v1/projects/{project}/advancedjoins/update', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{cluster}.cognitedata.com/api/v1/projects/{project}/advancedjoins/update",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'items' => [
[
'externalId' => 'my.known.id',
'update' => [
'matchers' => [
'set' => [
[
'type' => 'raw',
'dbName' => '<string>',
'tableName' => '<string>',
'fromColumnKey' => '<string>',
'toColumnKey' => '<string>'
]
]
]
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{cluster}.cognitedata.com/api/v1/projects/{project}/advancedjoins/update"
payload := strings.NewReader("{\n \"items\": [\n {\n \"externalId\": \"my.known.id\",\n \"update\": {\n \"matchers\": {\n \"set\": [\n {\n \"type\": \"raw\",\n \"dbName\": \"<string>\",\n \"tableName\": \"<string>\",\n \"fromColumnKey\": \"<string>\",\n \"toColumnKey\": \"<string>\"\n }\n ]\n }\n }\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://{cluster}.cognitedata.com/api/v1/projects/{project}/advancedjoins/update")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"items\": [\n {\n \"externalId\": \"my.known.id\",\n \"update\": {\n \"matchers\": {\n \"set\": [\n {\n \"type\": \"raw\",\n \"dbName\": \"<string>\",\n \"tableName\": \"<string>\",\n \"fromColumnKey\": \"<string>\",\n \"toColumnKey\": \"<string>\"\n }\n ]\n }\n }\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{cluster}.cognitedata.com/api/v1/projects/{project}/advancedjoins/update")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"items\": [\n {\n \"externalId\": \"my.known.id\",\n \"update\": {\n \"matchers\": {\n \"set\": [\n {\n \"type\": \"raw\",\n \"dbName\": \"<string>\",\n \"tableName\": \"<string>\",\n \"fromColumnKey\": \"<string>\",\n \"toColumnKey\": \"<string>\"\n }\n ]\n }\n }\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"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>"
}
]
}
]
}{
"error": {
"code": 400,
"message": "`null` values aren't allowed."
}
}Authorizations
oidc-tokenoauth2-client-credentialsoauth2-open-industrial-dataoauth2-auth-code
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
application/json
Required array length:
1 - 1000 elementsShow child attributes
Show child attributes
Response
The advanced joins that were updated
Required array length:
1 - 100 elementsShow child attributes
Show child attributes
Last modified on July 10, 2026
Was this page helpful?
⌘I