Filter which nodes are within a boundingbox for a revision.
curl --request POST \
--url https://{cluster}.cognitedata.com/api/v1/projects/{project}/3d/nodes/list \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"model": {
"instanceId": {
"space": "<string>",
"externalId": "<string>"
}
},
"revision": {
"instanceId": {
"space": "<string>",
"externalId": "<string>"
}
},
"filterNodesByBoundingBox": {
"boundingBox": {
"xMin": 123,
"xMax": 123,
"yMin": 123,
"yMax": 123,
"zMin": 123,
"zMax": 123
},
"nodeIds": [
123
]
}
}
'import requests
url = "https://{cluster}.cognitedata.com/api/v1/projects/{project}/3d/nodes/list"
payload = {
"model": { "instanceId": {
"space": "<string>",
"externalId": "<string>"
} },
"revision": { "instanceId": {
"space": "<string>",
"externalId": "<string>"
} },
"filterNodesByBoundingBox": {
"boundingBox": {
"xMin": 123,
"xMax": 123,
"yMin": 123,
"yMax": 123,
"zMin": 123,
"zMax": 123
},
"nodeIds": [123]
}
}
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({
model: {instanceId: {space: '<string>', externalId: '<string>'}},
revision: {instanceId: {space: '<string>', externalId: '<string>'}},
filterNodesByBoundingBox: {
boundingBox: {xMin: 123, xMax: 123, yMin: 123, yMax: 123, zMin: 123, zMax: 123},
nodeIds: [123]
}
})
};
fetch('https://{cluster}.cognitedata.com/api/v1/projects/{project}/3d/nodes/list', 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}/3d/nodes/list",
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([
'model' => [
'instanceId' => [
'space' => '<string>',
'externalId' => '<string>'
]
],
'revision' => [
'instanceId' => [
'space' => '<string>',
'externalId' => '<string>'
]
],
'filterNodesByBoundingBox' => [
'boundingBox' => [
'xMin' => 123,
'xMax' => 123,
'yMin' => 123,
'yMax' => 123,
'zMin' => 123,
'zMax' => 123
],
'nodeIds' => [
123
]
]
]),
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/nodes/list"
payload := strings.NewReader("{\n \"model\": {\n \"instanceId\": {\n \"space\": \"<string>\",\n \"externalId\": \"<string>\"\n }\n },\n \"revision\": {\n \"instanceId\": {\n \"space\": \"<string>\",\n \"externalId\": \"<string>\"\n }\n },\n \"filterNodesByBoundingBox\": {\n \"boundingBox\": {\n \"xMin\": 123,\n \"xMax\": 123,\n \"yMin\": 123,\n \"yMax\": 123,\n \"zMin\": 123,\n \"zMax\": 123\n },\n \"nodeIds\": [\n 123\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}/3d/nodes/list")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"model\": {\n \"instanceId\": {\n \"space\": \"<string>\",\n \"externalId\": \"<string>\"\n }\n },\n \"revision\": {\n \"instanceId\": {\n \"space\": \"<string>\",\n \"externalId\": \"<string>\"\n }\n },\n \"filterNodesByBoundingBox\": {\n \"boundingBox\": {\n \"xMin\": 123,\n \"xMax\": 123,\n \"yMin\": 123,\n \"yMax\": 123,\n \"zMin\": 123,\n \"zMax\": 123\n },\n \"nodeIds\": [\n 123\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{cluster}.cognitedata.com/api/v1/projects/{project}/3d/nodes/list")
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 \"model\": {\n \"instanceId\": {\n \"space\": \"<string>\",\n \"externalId\": \"<string>\"\n }\n },\n \"revision\": {\n \"instanceId\": {\n \"space\": \"<string>\",\n \"externalId\": \"<string>\"\n }\n },\n \"filterNodesByBoundingBox\": {\n \"boundingBox\": {\n \"xMin\": 123,\n \"xMax\": 123,\n \"yMin\": 123,\n \"yMax\": 123,\n \"zMin\": 123,\n \"zMax\": 123\n },\n \"nodeIds\": [\n 123\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"items": [
{
"id": 1000,
"treeIndex": 3,
"depth": 2,
"name": "Node name",
"subtreeSize": 4,
"boundingBox": {
"max": [
123
],
"min": [
123
]
}
}
],
"nextCursor": "<string>"
}{
"error": {
"code": 401,
"message": "Could not authenticate.",
"missing": [
{}
],
"duplicated": [
{}
]
}
}Filter which nodes are within a boundingbox for a revision.
This endpoint is only supported in dm-only projects.
The nodeIds can be found as part of a CogniteCadNode in the field cadNodeReference.
Similar functionality is supported in classic through:
- list 3D asset mappings endpoint + intersectsBoundingBox
POST
/
3d
/
nodes
/
list
Filter which nodes are within a boundingbox for a revision.
curl --request POST \
--url https://{cluster}.cognitedata.com/api/v1/projects/{project}/3d/nodes/list \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"model": {
"instanceId": {
"space": "<string>",
"externalId": "<string>"
}
},
"revision": {
"instanceId": {
"space": "<string>",
"externalId": "<string>"
}
},
"filterNodesByBoundingBox": {
"boundingBox": {
"xMin": 123,
"xMax": 123,
"yMin": 123,
"yMax": 123,
"zMin": 123,
"zMax": 123
},
"nodeIds": [
123
]
}
}
'import requests
url = "https://{cluster}.cognitedata.com/api/v1/projects/{project}/3d/nodes/list"
payload = {
"model": { "instanceId": {
"space": "<string>",
"externalId": "<string>"
} },
"revision": { "instanceId": {
"space": "<string>",
"externalId": "<string>"
} },
"filterNodesByBoundingBox": {
"boundingBox": {
"xMin": 123,
"xMax": 123,
"yMin": 123,
"yMax": 123,
"zMin": 123,
"zMax": 123
},
"nodeIds": [123]
}
}
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({
model: {instanceId: {space: '<string>', externalId: '<string>'}},
revision: {instanceId: {space: '<string>', externalId: '<string>'}},
filterNodesByBoundingBox: {
boundingBox: {xMin: 123, xMax: 123, yMin: 123, yMax: 123, zMin: 123, zMax: 123},
nodeIds: [123]
}
})
};
fetch('https://{cluster}.cognitedata.com/api/v1/projects/{project}/3d/nodes/list', 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}/3d/nodes/list",
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([
'model' => [
'instanceId' => [
'space' => '<string>',
'externalId' => '<string>'
]
],
'revision' => [
'instanceId' => [
'space' => '<string>',
'externalId' => '<string>'
]
],
'filterNodesByBoundingBox' => [
'boundingBox' => [
'xMin' => 123,
'xMax' => 123,
'yMin' => 123,
'yMax' => 123,
'zMin' => 123,
'zMax' => 123
],
'nodeIds' => [
123
]
]
]),
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/nodes/list"
payload := strings.NewReader("{\n \"model\": {\n \"instanceId\": {\n \"space\": \"<string>\",\n \"externalId\": \"<string>\"\n }\n },\n \"revision\": {\n \"instanceId\": {\n \"space\": \"<string>\",\n \"externalId\": \"<string>\"\n }\n },\n \"filterNodesByBoundingBox\": {\n \"boundingBox\": {\n \"xMin\": 123,\n \"xMax\": 123,\n \"yMin\": 123,\n \"yMax\": 123,\n \"zMin\": 123,\n \"zMax\": 123\n },\n \"nodeIds\": [\n 123\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}/3d/nodes/list")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"model\": {\n \"instanceId\": {\n \"space\": \"<string>\",\n \"externalId\": \"<string>\"\n }\n },\n \"revision\": {\n \"instanceId\": {\n \"space\": \"<string>\",\n \"externalId\": \"<string>\"\n }\n },\n \"filterNodesByBoundingBox\": {\n \"boundingBox\": {\n \"xMin\": 123,\n \"xMax\": 123,\n \"yMin\": 123,\n \"yMax\": 123,\n \"zMin\": 123,\n \"zMax\": 123\n },\n \"nodeIds\": [\n 123\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{cluster}.cognitedata.com/api/v1/projects/{project}/3d/nodes/list")
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 \"model\": {\n \"instanceId\": {\n \"space\": \"<string>\",\n \"externalId\": \"<string>\"\n }\n },\n \"revision\": {\n \"instanceId\": {\n \"space\": \"<string>\",\n \"externalId\": \"<string>\"\n }\n },\n \"filterNodesByBoundingBox\": {\n \"boundingBox\": {\n \"xMin\": 123,\n \"xMax\": 123,\n \"yMin\": 123,\n \"yMax\": 123,\n \"zMin\": 123,\n \"zMax\": 123\n },\n \"nodeIds\": [\n 123\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"items": [
{
"id": 1000,
"treeIndex": 3,
"depth": 2,
"name": "Node name",
"subtreeSize": 4,
"boundingBox": {
"max": [
123
],
"min": [
123
]
}
}
],
"nextCursor": "<string>"
}{
"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
The Model, Revision, a list of nodes and an area definition
Last modified on July 10, 2026
Was this page helpful?
⌘I