curl --request POST \
--url https://{cluster}.cognitedata.com/api/v1/projects/{project}/3d/contextualization/pointcloud \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"items": [
{
"assetInstanceId": {
"space": "<string>",
"externalId": "<string>"
},
"volumeReference": "<string>",
"volume": {
"type": "Box",
"version": "1.0.0",
"data": [
123
]
}
}
],
"dmsContextualizationConfig": {
"object3DSpace": "<string>",
"contextualizationSpace": "<string>",
"revisionInstanceId": {
"space": "<string>",
"externalId": "<string>"
}
}
}
'import requests
url = "https://{cluster}.cognitedata.com/api/v1/projects/{project}/3d/contextualization/pointcloud"
payload = {
"items": [
{
"assetInstanceId": {
"space": "<string>",
"externalId": "<string>"
},
"volumeReference": "<string>",
"volume": {
"type": "Box",
"version": "1.0.0",
"data": [123]
}
}
],
"dmsContextualizationConfig": {
"object3DSpace": "<string>",
"contextualizationSpace": "<string>",
"revisionInstanceId": {
"space": "<string>",
"externalId": "<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: [
{
assetInstanceId: {space: '<string>', externalId: '<string>'},
volumeReference: '<string>',
volume: {type: 'Box', version: '1.0.0', data: [123]}
}
],
dmsContextualizationConfig: {
object3DSpace: '<string>',
contextualizationSpace: '<string>',
revisionInstanceId: {space: '<string>', externalId: '<string>'}
}
})
};
fetch('https://{cluster}.cognitedata.com/api/v1/projects/{project}/3d/contextualization/pointcloud', 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/contextualization/pointcloud",
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' => [
[
'assetInstanceId' => [
'space' => '<string>',
'externalId' => '<string>'
],
'volumeReference' => '<string>',
'volume' => [
'type' => 'Box',
'version' => '1.0.0',
'data' => [
123
]
]
]
],
'dmsContextualizationConfig' => [
'object3DSpace' => '<string>',
'contextualizationSpace' => '<string>',
'revisionInstanceId' => [
'space' => '<string>',
'externalId' => '<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}/3d/contextualization/pointcloud"
payload := strings.NewReader("{\n \"items\": [\n {\n \"assetInstanceId\": {\n \"space\": \"<string>\",\n \"externalId\": \"<string>\"\n },\n \"volumeReference\": \"<string>\",\n \"volume\": {\n \"type\": \"Box\",\n \"version\": \"1.0.0\",\n \"data\": [\n 123\n ]\n }\n }\n ],\n \"dmsContextualizationConfig\": {\n \"object3DSpace\": \"<string>\",\n \"contextualizationSpace\": \"<string>\",\n \"revisionInstanceId\": {\n \"space\": \"<string>\",\n \"externalId\": \"<string>\"\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/contextualization/pointcloud")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"items\": [\n {\n \"assetInstanceId\": {\n \"space\": \"<string>\",\n \"externalId\": \"<string>\"\n },\n \"volumeReference\": \"<string>\",\n \"volume\": {\n \"type\": \"Box\",\n \"version\": \"1.0.0\",\n \"data\": [\n 123\n ]\n }\n }\n ],\n \"dmsContextualizationConfig\": {\n \"object3DSpace\": \"<string>\",\n \"contextualizationSpace\": \"<string>\",\n \"revisionInstanceId\": {\n \"space\": \"<string>\",\n \"externalId\": \"<string>\"\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{cluster}.cognitedata.com/api/v1/projects/{project}/3d/contextualization/pointcloud")
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 \"assetInstanceId\": {\n \"space\": \"<string>\",\n \"externalId\": \"<string>\"\n },\n \"volumeReference\": \"<string>\",\n \"volume\": {\n \"type\": \"Box\",\n \"version\": \"1.0.0\",\n \"data\": [\n 123\n ]\n }\n }\n ],\n \"dmsContextualizationConfig\": {\n \"object3DSpace\": \"<string>\",\n \"contextualizationSpace\": \"<string>\",\n \"revisionInstanceId\": {\n \"space\": \"<string>\",\n \"externalId\": \"<string>\"\n }\n }\n}"
response = http.request(request)
puts response.read_body{}{
"error": {
"code": 401,
"message": "Could not authenticate.",
"missing": [
{}
],
"duplicated": [
{}
]
}
}Create point cloud volume contextualization
Create links between point cloud volume references and CogniteAsset instances.
Use this endpoint to connect point cloud volume references in a specific point cloud revision to assets in data modeling projects.
These links let users navigate between point cloud volumes and related assets.
The point cloud volumes are scoped to the referenced point cloud revision. Asset references use the space and externalId of CogniteAsset instances.
Note: This endpoint is available only in data modeling projects.
curl --request POST \
--url https://{cluster}.cognitedata.com/api/v1/projects/{project}/3d/contextualization/pointcloud \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"items": [
{
"assetInstanceId": {
"space": "<string>",
"externalId": "<string>"
},
"volumeReference": "<string>",
"volume": {
"type": "Box",
"version": "1.0.0",
"data": [
123
]
}
}
],
"dmsContextualizationConfig": {
"object3DSpace": "<string>",
"contextualizationSpace": "<string>",
"revisionInstanceId": {
"space": "<string>",
"externalId": "<string>"
}
}
}
'import requests
url = "https://{cluster}.cognitedata.com/api/v1/projects/{project}/3d/contextualization/pointcloud"
payload = {
"items": [
{
"assetInstanceId": {
"space": "<string>",
"externalId": "<string>"
},
"volumeReference": "<string>",
"volume": {
"type": "Box",
"version": "1.0.0",
"data": [123]
}
}
],
"dmsContextualizationConfig": {
"object3DSpace": "<string>",
"contextualizationSpace": "<string>",
"revisionInstanceId": {
"space": "<string>",
"externalId": "<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: [
{
assetInstanceId: {space: '<string>', externalId: '<string>'},
volumeReference: '<string>',
volume: {type: 'Box', version: '1.0.0', data: [123]}
}
],
dmsContextualizationConfig: {
object3DSpace: '<string>',
contextualizationSpace: '<string>',
revisionInstanceId: {space: '<string>', externalId: '<string>'}
}
})
};
fetch('https://{cluster}.cognitedata.com/api/v1/projects/{project}/3d/contextualization/pointcloud', 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/contextualization/pointcloud",
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' => [
[
'assetInstanceId' => [
'space' => '<string>',
'externalId' => '<string>'
],
'volumeReference' => '<string>',
'volume' => [
'type' => 'Box',
'version' => '1.0.0',
'data' => [
123
]
]
]
],
'dmsContextualizationConfig' => [
'object3DSpace' => '<string>',
'contextualizationSpace' => '<string>',
'revisionInstanceId' => [
'space' => '<string>',
'externalId' => '<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}/3d/contextualization/pointcloud"
payload := strings.NewReader("{\n \"items\": [\n {\n \"assetInstanceId\": {\n \"space\": \"<string>\",\n \"externalId\": \"<string>\"\n },\n \"volumeReference\": \"<string>\",\n \"volume\": {\n \"type\": \"Box\",\n \"version\": \"1.0.0\",\n \"data\": [\n 123\n ]\n }\n }\n ],\n \"dmsContextualizationConfig\": {\n \"object3DSpace\": \"<string>\",\n \"contextualizationSpace\": \"<string>\",\n \"revisionInstanceId\": {\n \"space\": \"<string>\",\n \"externalId\": \"<string>\"\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/contextualization/pointcloud")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"items\": [\n {\n \"assetInstanceId\": {\n \"space\": \"<string>\",\n \"externalId\": \"<string>\"\n },\n \"volumeReference\": \"<string>\",\n \"volume\": {\n \"type\": \"Box\",\n \"version\": \"1.0.0\",\n \"data\": [\n 123\n ]\n }\n }\n ],\n \"dmsContextualizationConfig\": {\n \"object3DSpace\": \"<string>\",\n \"contextualizationSpace\": \"<string>\",\n \"revisionInstanceId\": {\n \"space\": \"<string>\",\n \"externalId\": \"<string>\"\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{cluster}.cognitedata.com/api/v1/projects/{project}/3d/contextualization/pointcloud")
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 \"assetInstanceId\": {\n \"space\": \"<string>\",\n \"externalId\": \"<string>\"\n },\n \"volumeReference\": \"<string>\",\n \"volume\": {\n \"type\": \"Box\",\n \"version\": \"1.0.0\",\n \"data\": [\n 123\n ]\n }\n }\n ],\n \"dmsContextualizationConfig\": {\n \"object3DSpace\": \"<string>\",\n \"contextualizationSpace\": \"<string>\",\n \"revisionInstanceId\": {\n \"space\": \"<string>\",\n \"externalId\": \"<string>\"\n }\n }\n}"
response = http.request(request)
puts response.read_body{}{
"error": {
"code": 401,
"message": "Could not authenticate.",
"missing": [
{}
],
"duplicated": [
{}
]
}
}Authorizations
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
The assetInstanceId, dmsContextualizationConfig and a list of point cloud volume data.
Response
Empty response.
The response is of type object.
Was this page helpful?