Get 3D nodes by ID
Required capabilities:
threedAcl:READ
Retrieves specific nodes given by a list of IDs.
POST
/
3d
/
models
/
{modelId}
/
revisions
/
{revisionId}
/
nodes
/
byids
JavaScript SDK
const nodes3d = await client.revisions3D.retrieve3DNodes(8252999965991682, 4190022127342195, [{id: 123}, {id: 456}]);List<Item> byInternalIds = List.of(Item.newBuilder().setId(10).build());
List<ThreeDNode> nodesByIds = client.threeD()
.models()
.revisions()
.nodes()
.retrieve(model.getId(), revision.getId(), byInternalIds);
List<Item> byExternalIds = List.of(Item.newBuilder().setExternalId("10").build());
List<ThreeDNode> nodesByIds = client.threeD()
.models()
.revisions()
.nodes()
.retrieve(model.getId(), revision.getId(), byExternalIds);
curl --request POST \
--url https://{cluster}.cognitedata.com/api/v1/projects/{project}/3d/models/{modelId}/revisions/{revisionId}/nodes/byids \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"items": [
{
"id": 1000
}
]
}
'import requests
url = "https://{cluster}.cognitedata.com/api/v1/projects/{project}/3d/models/{modelId}/revisions/{revisionId}/nodes/byids"
payload = { "items": [{ "id": 1000 }] }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{cluster}.cognitedata.com/api/v1/projects/{project}/3d/models/{modelId}/revisions/{revisionId}/nodes/byids",
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' => 1000
]
]
]),
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/{modelId}/revisions/{revisionId}/nodes/byids"
payload := strings.NewReader("{\n \"items\": [\n {\n \"id\": 1000\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/{modelId}/revisions/{revisionId}/nodes/byids")
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\": 1000\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"items": [
{
"id": 1000,
"treeIndex": 3,
"depth": 2,
"name": "Node name",
"subtreeSize": 4,
"parentId": 2,
"properties": {
"category1": {
"property1": "value1",
"property2": "value2"
},
"category2": {
"property1": "value1",
"property2": "value2"
}
},
"boundingBox": {
"max": [
123
],
"min": [
123
]
}
}
]
}{
"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.
Scopes
Body
application/json
The request body containing the IDs of the nodes to retrieve. Will return error 400 if the revision is still being processed.
⌘I
JavaScript SDK
const nodes3d = await client.revisions3D.retrieve3DNodes(8252999965991682, 4190022127342195, [{id: 123}, {id: 456}]);List<Item> byInternalIds = List.of(Item.newBuilder().setId(10).build());
List<ThreeDNode> nodesByIds = client.threeD()
.models()
.revisions()
.nodes()
.retrieve(model.getId(), revision.getId(), byInternalIds);
List<Item> byExternalIds = List.of(Item.newBuilder().setExternalId("10").build());
List<ThreeDNode> nodesByIds = client.threeD()
.models()
.revisions()
.nodes()
.retrieve(model.getId(), revision.getId(), byExternalIds);
curl --request POST \
--url https://{cluster}.cognitedata.com/api/v1/projects/{project}/3d/models/{modelId}/revisions/{revisionId}/nodes/byids \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"items": [
{
"id": 1000
}
]
}
'import requests
url = "https://{cluster}.cognitedata.com/api/v1/projects/{project}/3d/models/{modelId}/revisions/{revisionId}/nodes/byids"
payload = { "items": [{ "id": 1000 }] }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{cluster}.cognitedata.com/api/v1/projects/{project}/3d/models/{modelId}/revisions/{revisionId}/nodes/byids",
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' => 1000
]
]
]),
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/{modelId}/revisions/{revisionId}/nodes/byids"
payload := strings.NewReader("{\n \"items\": [\n {\n \"id\": 1000\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/{modelId}/revisions/{revisionId}/nodes/byids")
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\": 1000\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"items": [
{
"id": 1000,
"treeIndex": 3,
"depth": 2,
"name": "Node name",
"subtreeSize": 4,
"parentId": 2,
"properties": {
"category1": {
"property1": "value1",
"property2": "value2"
},
"category2": {
"property1": "value1",
"property2": "value2"
}
},
"boundingBox": {
"max": [
123
],
"min": [
123
]
}
}
]
}{
"error": {
"code": 401,
"message": "Could not authenticate.",
"missing": [
{}
],
"duplicated": [
{}
]
}
}