JavaScript SDK
const modelsToUpdate = [
{ id: 3744350296805509, update: { name: { set: 'Model 0 updated' }}},
{ id: 8163365893677939, update: { name: { set: 'Model 2 updated' }}},
];
const models3D = await client.models3D.update(modelsToUpdate);three_d_model = client.three_d.models.retrieve(id=1)
three_d_model.name = "New Name"
res = client.three_d.models.update(three_d_model)
from cognite.client.data_classes import ThreeDModelUpdate
my_update = ThreeDModelUpdate(id=1).name.set("New Name")
res = client.three_d.models.update(my_update)ThreeDModel update = upsertThreeDModelsList.get(0).toBuilder()
.setName("Update Test").build();
List<ThreeDModel> listUpsert =
client.threeD()
.models()
.upsert(List.of(update));curl --request POST \
--url https://{cluster}.cognitedata.com/api/v1/projects/{project}/3d/models/update \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"items": [
{
"id": 4503599627370496,
"update": {
"name": {
"set": "<string>"
},
"dataSetId": {
"set": 4503599627370496
},
"metadata": {
"set": {
"key1": "value1",
"key2": "value2"
}
}
}
}
]
}
'<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{cluster}.cognitedata.com/api/v1/projects/{project}/3d/models/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' => [
[
'id' => 4503599627370496,
'update' => [
'name' => [
'set' => '<string>'
],
'dataSetId' => [
'set' => 4503599627370496
],
'metadata' => [
'set' => [
'key1' => 'value1',
'key2' => 'value2'
]
]
]
]
]
]),
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}/3d/models/update"
payload := strings.NewReader("{\n \"items\": [\n {\n \"id\": 4503599627370496,\n \"update\": {\n \"name\": {\n \"set\": \"<string>\"\n },\n \"dataSetId\": {\n \"set\": 4503599627370496\n },\n \"metadata\": {\n \"set\": {\n \"key1\": \"value1\",\n \"key2\": \"value2\"\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))
}require 'uri'
require 'net/http'
url = URI("https://{cluster}.cognitedata.com/api/v1/projects/{project}/3d/models/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 \"id\": 4503599627370496,\n \"update\": {\n \"name\": {\n \"set\": \"<string>\"\n },\n \"dataSetId\": {\n \"set\": 4503599627370496\n },\n \"metadata\": {\n \"set\": {\n \"key1\": \"value1\",\n \"key2\": \"value2\"\n }\n }\n }\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"items": [
{
"name": "My Model",
"id": 1000,
"createdTime": 0,
"dataSetId": 4503599627370496,
"space": "<string>",
"metadata": {}
}
]
}{
"error": {
"code": 401,
"message": "Could not authenticate.",
"missing": [
{}
],
"duplicated": [
{}
]
}
}Update 3D models
Required capabilities:
threedAcl:UPDATE
POST
/
3d
/
models
/
update
JavaScript SDK
const modelsToUpdate = [
{ id: 3744350296805509, update: { name: { set: 'Model 0 updated' }}},
{ id: 8163365893677939, update: { name: { set: 'Model 2 updated' }}},
];
const models3D = await client.models3D.update(modelsToUpdate);three_d_model = client.three_d.models.retrieve(id=1)
three_d_model.name = "New Name"
res = client.three_d.models.update(three_d_model)
from cognite.client.data_classes import ThreeDModelUpdate
my_update = ThreeDModelUpdate(id=1).name.set("New Name")
res = client.three_d.models.update(my_update)ThreeDModel update = upsertThreeDModelsList.get(0).toBuilder()
.setName("Update Test").build();
List<ThreeDModel> listUpsert =
client.threeD()
.models()
.upsert(List.of(update));curl --request POST \
--url https://{cluster}.cognitedata.com/api/v1/projects/{project}/3d/models/update \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"items": [
{
"id": 4503599627370496,
"update": {
"name": {
"set": "<string>"
},
"dataSetId": {
"set": 4503599627370496
},
"metadata": {
"set": {
"key1": "value1",
"key2": "value2"
}
}
}
}
]
}
'<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{cluster}.cognitedata.com/api/v1/projects/{project}/3d/models/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' => [
[
'id' => 4503599627370496,
'update' => [
'name' => [
'set' => '<string>'
],
'dataSetId' => [
'set' => 4503599627370496
],
'metadata' => [
'set' => [
'key1' => 'value1',
'key2' => 'value2'
]
]
]
]
]
]),
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}/3d/models/update"
payload := strings.NewReader("{\n \"items\": [\n {\n \"id\": 4503599627370496,\n \"update\": {\n \"name\": {\n \"set\": \"<string>\"\n },\n \"dataSetId\": {\n \"set\": 4503599627370496\n },\n \"metadata\": {\n \"set\": {\n \"key1\": \"value1\",\n \"key2\": \"value2\"\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))
}require 'uri'
require 'net/http'
url = URI("https://{cluster}.cognitedata.com/api/v1/projects/{project}/3d/models/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 \"id\": 4503599627370496,\n \"update\": {\n \"name\": {\n \"set\": \"<string>\"\n },\n \"dataSetId\": {\n \"set\": 4503599627370496\n },\n \"metadata\": {\n \"set\": {\n \"key1\": \"value1\",\n \"key2\": \"value2\"\n }\n }\n }\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"items": [
{
"name": "My Model",
"id": 1000,
"createdTime": 0,
"dataSetId": 4503599627370496,
"space": "<string>",
"metadata": {}
}
]
}{
"error": {
"code": 401,
"message": "Could not authenticate.",
"missing": [
{}
],
"duplicated": [
{}
]
}
}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
List of changes.
- Option 1
- Option 2
Required array length:
1 - 1000 elementsShow child attributes
Show child attributes
Response
Corresponding models after applying the updates.
Show child attributes
Show child attributes
Last modified on July 10, 2026
Was this page helpful?
⌘I