Create or update views
Required capabilities:
dataModelsAcl:WRITE
Add or update (upsert) views. For unchanged view specifications, the operation completes without making any changes. We will not update the lastUpdatedTime value for views that remain unchanged.
POST
/
models
/
views
Python SDK
from cognite.client.data_classes.data_modeling import ViewApply, MappedPropertyApply, ContainerId
views = [
ViewApply(
space="mySpace",
external_id="myView",
version="v1",
properties={
"someAlias": MappedPropertyApply(
container=ContainerId("mySpace", "myContainer"),
container_property_identifier="someProperty",
),
}
)
]
res = client.data_modeling.views.apply(views)
from cognite.client.data_classes.data_modeling import (
ContainerId,
DirectRelationReference,
MappedPropertyApply,
MultiEdgeConnectionApply,
ViewApply,
ViewId
)
acts_in_edge_type = DirectRelationReference(space="imdb", external_id="acts-in")
movie_view = ViewApply(
space="imdb",
external_id="Movie",
version="1",
name="Movie",
properties={
"title": MappedPropertyApply(
container=ContainerId(space="imdb", external_id="Movie"),
container_property_identifier="title",
),
"actors": MultiEdgeConnectionApply(
type=acts_in_edge_type,
direction="inwards",
source=ViewId("imdb", "Actor", "1"),
name="actors",
),
}
)
actor_view = ViewApply(
space="imdb",
external_id="Actor",
version="1",
name="Actor",
properties={
"name": MappedPropertyApply(
container=ContainerId("imdb", "Actor"),
name="name",
container_property_identifier="name",
),
"movies": MultiEdgeConnectionApply(
type=acts_in_edge_type,
direction="outwards",
source=ViewId("imdb", "Movie", "1"),
name="movies",
),
}
)
res = client.data_modeling.views.apply([movie_view, actor_view])curl --request POST \
--url https://{cluster}.cognitedata.com/api/v1/projects/{project}/models/views \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"items": [
{
"externalId": "<string>",
"space": "<string>",
"version": "<string>",
"name": "<string>",
"description": "<string>",
"implements": [
{
"type": "view",
"space": "<string>",
"externalId": "<string>",
"version": "<string>"
}
],
"filter": {
"and": [
{
"in": {
"property": [
"tag"
],
"values": [
"1001_1",
"1001_1"
]
}
},
{
"range": {
"property": [
"weight"
],
"gte": 0
}
}
]
},
"properties": {}
}
]
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
items: [
{
externalId: '<string>',
space: '<string>',
version: '<string>',
name: '<string>',
description: '<string>',
implements: [{type: 'view', space: '<string>', externalId: '<string>', version: '<string>'}],
filter: {
and: [
{in: {property: ['tag'], values: ['1001_1', '1001_1']}},
{range: {property: ['weight'], gte: 0}}
]
},
properties: {}
}
]
})
};
fetch('https://{cluster}.cognitedata.com/api/v1/projects/{project}/models/views', 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}/models/views",
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' => '<string>',
'space' => '<string>',
'version' => '<string>',
'name' => '<string>',
'description' => '<string>',
'implements' => [
[
'type' => 'view',
'space' => '<string>',
'externalId' => '<string>',
'version' => '<string>'
]
],
'filter' => [
'and' => [
[
'in' => [
'property' => [
'tag'
],
'values' => [
'1001_1',
'1001_1'
]
]
],
[
'range' => [
'property' => [
'weight'
],
'gte' => 0
]
]
]
],
'properties' => [
]
]
]
]),
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}/models/views"
payload := strings.NewReader("{\n \"items\": [\n {\n \"externalId\": \"<string>\",\n \"space\": \"<string>\",\n \"version\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"implements\": [\n {\n \"type\": \"view\",\n \"space\": \"<string>\",\n \"externalId\": \"<string>\",\n \"version\": \"<string>\"\n }\n ],\n \"filter\": {\n \"and\": [\n {\n \"in\": {\n \"property\": [\n \"tag\"\n ],\n \"values\": [\n \"1001_1\",\n \"1001_1\"\n ]\n }\n },\n {\n \"range\": {\n \"property\": [\n \"weight\"\n ],\n \"gte\": 0\n }\n }\n ]\n },\n \"properties\": {}\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}/models/views")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"items\": [\n {\n \"externalId\": \"<string>\",\n \"space\": \"<string>\",\n \"version\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"implements\": [\n {\n \"type\": \"view\",\n \"space\": \"<string>\",\n \"externalId\": \"<string>\",\n \"version\": \"<string>\"\n }\n ],\n \"filter\": {\n \"and\": [\n {\n \"in\": {\n \"property\": [\n \"tag\"\n ],\n \"values\": [\n \"1001_1\",\n \"1001_1\"\n ]\n }\n },\n {\n \"range\": {\n \"property\": [\n \"weight\"\n ],\n \"gte\": 0\n }\n }\n ]\n },\n \"properties\": {}\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{cluster}.cognitedata.com/api/v1/projects/{project}/models/views")
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\": \"<string>\",\n \"space\": \"<string>\",\n \"version\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"implements\": [\n {\n \"type\": \"view\",\n \"space\": \"<string>\",\n \"externalId\": \"<string>\",\n \"version\": \"<string>\"\n }\n ],\n \"filter\": {\n \"and\": [\n {\n \"in\": {\n \"property\": [\n \"tag\"\n ],\n \"values\": [\n \"1001_1\",\n \"1001_1\"\n ]\n }\n },\n {\n \"range\": {\n \"property\": [\n \"weight\"\n ],\n \"gte\": 0\n }\n }\n ]\n },\n \"properties\": {}\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"items": [
{
"externalId": "<string>",
"space": "<string>",
"version": "<string>",
"createdTime": 1730204346000,
"lastUpdatedTime": 1730204346000,
"writable": true,
"queryable": true,
"usedFor": "node",
"isGlobal": true,
"properties": {},
"mappedContainers": [
{
"type": "container",
"space": "<string>",
"externalId": "<string>"
}
],
"name": "<string>",
"description": "<string>",
"implements": [
{
"type": "view",
"space": "<string>",
"externalId": "<string>",
"version": "<string>"
}
],
"filter": {
"and": [
{
"in": {
"property": [
"tag"
],
"values": [
"1001_1",
"1001_1"
]
}
},
{
"range": {
"property": [
"weight"
],
"gte": 0
}
}
]
}
}
]
}{
"error": {
"code": 401,
"message": "Could not authenticate.",
"missing": [
{}
],
"duplicated": [
{}
]
}
}{
"error": {
"code": 409,
"message": "<string>",
"isAutoRetryable": true
}
}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
Views to add or update.
List of views to create/update
Required array length:
1 - 100 elements- View
- Record View
Show child attributes
Show child attributes
Response
List of views
List of views
- View
- Record View
Show child attributes
Show child attributes
⌘I
Python SDK
from cognite.client.data_classes.data_modeling import ViewApply, MappedPropertyApply, ContainerId
views = [
ViewApply(
space="mySpace",
external_id="myView",
version="v1",
properties={
"someAlias": MappedPropertyApply(
container=ContainerId("mySpace", "myContainer"),
container_property_identifier="someProperty",
),
}
)
]
res = client.data_modeling.views.apply(views)
from cognite.client.data_classes.data_modeling import (
ContainerId,
DirectRelationReference,
MappedPropertyApply,
MultiEdgeConnectionApply,
ViewApply,
ViewId
)
acts_in_edge_type = DirectRelationReference(space="imdb", external_id="acts-in")
movie_view = ViewApply(
space="imdb",
external_id="Movie",
version="1",
name="Movie",
properties={
"title": MappedPropertyApply(
container=ContainerId(space="imdb", external_id="Movie"),
container_property_identifier="title",
),
"actors": MultiEdgeConnectionApply(
type=acts_in_edge_type,
direction="inwards",
source=ViewId("imdb", "Actor", "1"),
name="actors",
),
}
)
actor_view = ViewApply(
space="imdb",
external_id="Actor",
version="1",
name="Actor",
properties={
"name": MappedPropertyApply(
container=ContainerId("imdb", "Actor"),
name="name",
container_property_identifier="name",
),
"movies": MultiEdgeConnectionApply(
type=acts_in_edge_type,
direction="outwards",
source=ViewId("imdb", "Movie", "1"),
name="movies",
),
}
)
res = client.data_modeling.views.apply([movie_view, actor_view])curl --request POST \
--url https://{cluster}.cognitedata.com/api/v1/projects/{project}/models/views \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"items": [
{
"externalId": "<string>",
"space": "<string>",
"version": "<string>",
"name": "<string>",
"description": "<string>",
"implements": [
{
"type": "view",
"space": "<string>",
"externalId": "<string>",
"version": "<string>"
}
],
"filter": {
"and": [
{
"in": {
"property": [
"tag"
],
"values": [
"1001_1",
"1001_1"
]
}
},
{
"range": {
"property": [
"weight"
],
"gte": 0
}
}
]
},
"properties": {}
}
]
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
items: [
{
externalId: '<string>',
space: '<string>',
version: '<string>',
name: '<string>',
description: '<string>',
implements: [{type: 'view', space: '<string>', externalId: '<string>', version: '<string>'}],
filter: {
and: [
{in: {property: ['tag'], values: ['1001_1', '1001_1']}},
{range: {property: ['weight'], gte: 0}}
]
},
properties: {}
}
]
})
};
fetch('https://{cluster}.cognitedata.com/api/v1/projects/{project}/models/views', 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}/models/views",
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' => '<string>',
'space' => '<string>',
'version' => '<string>',
'name' => '<string>',
'description' => '<string>',
'implements' => [
[
'type' => 'view',
'space' => '<string>',
'externalId' => '<string>',
'version' => '<string>'
]
],
'filter' => [
'and' => [
[
'in' => [
'property' => [
'tag'
],
'values' => [
'1001_1',
'1001_1'
]
]
],
[
'range' => [
'property' => [
'weight'
],
'gte' => 0
]
]
]
],
'properties' => [
]
]
]
]),
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}/models/views"
payload := strings.NewReader("{\n \"items\": [\n {\n \"externalId\": \"<string>\",\n \"space\": \"<string>\",\n \"version\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"implements\": [\n {\n \"type\": \"view\",\n \"space\": \"<string>\",\n \"externalId\": \"<string>\",\n \"version\": \"<string>\"\n }\n ],\n \"filter\": {\n \"and\": [\n {\n \"in\": {\n \"property\": [\n \"tag\"\n ],\n \"values\": [\n \"1001_1\",\n \"1001_1\"\n ]\n }\n },\n {\n \"range\": {\n \"property\": [\n \"weight\"\n ],\n \"gte\": 0\n }\n }\n ]\n },\n \"properties\": {}\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}/models/views")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"items\": [\n {\n \"externalId\": \"<string>\",\n \"space\": \"<string>\",\n \"version\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"implements\": [\n {\n \"type\": \"view\",\n \"space\": \"<string>\",\n \"externalId\": \"<string>\",\n \"version\": \"<string>\"\n }\n ],\n \"filter\": {\n \"and\": [\n {\n \"in\": {\n \"property\": [\n \"tag\"\n ],\n \"values\": [\n \"1001_1\",\n \"1001_1\"\n ]\n }\n },\n {\n \"range\": {\n \"property\": [\n \"weight\"\n ],\n \"gte\": 0\n }\n }\n ]\n },\n \"properties\": {}\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{cluster}.cognitedata.com/api/v1/projects/{project}/models/views")
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\": \"<string>\",\n \"space\": \"<string>\",\n \"version\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"implements\": [\n {\n \"type\": \"view\",\n \"space\": \"<string>\",\n \"externalId\": \"<string>\",\n \"version\": \"<string>\"\n }\n ],\n \"filter\": {\n \"and\": [\n {\n \"in\": {\n \"property\": [\n \"tag\"\n ],\n \"values\": [\n \"1001_1\",\n \"1001_1\"\n ]\n }\n },\n {\n \"range\": {\n \"property\": [\n \"weight\"\n ],\n \"gte\": 0\n }\n }\n ]\n },\n \"properties\": {}\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"items": [
{
"externalId": "<string>",
"space": "<string>",
"version": "<string>",
"createdTime": 1730204346000,
"lastUpdatedTime": 1730204346000,
"writable": true,
"queryable": true,
"usedFor": "node",
"isGlobal": true,
"properties": {},
"mappedContainers": [
{
"type": "container",
"space": "<string>",
"externalId": "<string>"
}
],
"name": "<string>",
"description": "<string>",
"implements": [
{
"type": "view",
"space": "<string>",
"externalId": "<string>",
"version": "<string>"
}
],
"filter": {
"and": [
{
"in": {
"property": [
"tag"
],
"values": [
"1001_1",
"1001_1"
]
}
},
{
"range": {
"property": [
"weight"
],
"gte": 0
}
}
]
}
}
]
}{
"error": {
"code": 401,
"message": "Could not authenticate.",
"missing": [
{}
],
"duplicated": [
{}
]
}
}{
"error": {
"code": 409,
"message": "<string>",
"isAutoRetryable": true
}
}