Inspect containers
curl --request POST \
--url https://{cluster}.cognitedata.com/api/v1/projects/{project}/models/containers/inspect \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"inspectionOperations": {
"involvedViews": {
"allVersions": false
},
"totalInvolvedViewCount": {
"allVersions": false,
"includeUnavailableViews": true
}
},
"items": [
{
"space": "<string>",
"externalId": "<string>"
}
]
}
'import requests
url = "https://{cluster}.cognitedata.com/api/v1/projects/{project}/models/containers/inspect"
payload = {
"inspectionOperations": {
"involvedViews": { "allVersions": False },
"totalInvolvedViewCount": {
"allVersions": False,
"includeUnavailableViews": True
}
},
"items": [
{
"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({
inspectionOperations: {
involvedViews: {allVersions: false},
totalInvolvedViewCount: {allVersions: false, includeUnavailableViews: true}
},
items: [{space: '<string>', externalId: '<string>'}]
})
};
fetch('https://{cluster}.cognitedata.com/api/v1/projects/{project}/models/containers/inspect', 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/containers/inspect",
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([
'inspectionOperations' => [
'involvedViews' => [
'allVersions' => false
],
'totalInvolvedViewCount' => [
'allVersions' => false,
'includeUnavailableViews' => true
]
],
'items' => [
[
'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}/models/containers/inspect"
payload := strings.NewReader("{\n \"inspectionOperations\": {\n \"involvedViews\": {\n \"allVersions\": false\n },\n \"totalInvolvedViewCount\": {\n \"allVersions\": false,\n \"includeUnavailableViews\": true\n }\n },\n \"items\": [\n {\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}/models/containers/inspect")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"inspectionOperations\": {\n \"involvedViews\": {\n \"allVersions\": false\n },\n \"totalInvolvedViewCount\": {\n \"allVersions\": false,\n \"includeUnavailableViews\": true\n }\n },\n \"items\": [\n {\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}/models/containers/inspect")
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 \"inspectionOperations\": {\n \"involvedViews\": {\n \"allVersions\": false\n },\n \"totalInvolvedViewCount\": {\n \"allVersions\": false,\n \"includeUnavailableViews\": true\n }\n },\n \"items\": [\n {\n \"space\": \"<string>\",\n \"externalId\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"items": [
{
"externalId": "<string>",
"space": "<string>",
"inspectionResults": {
"involvedViewCount": 123,
"involvedViews": [
{
"type": "view",
"space": "<string>",
"externalId": "<string>",
"version": "<string>"
}
]
}
}
]
}{
"error": {
"code": 401,
"message": "Could not authenticate.",
"missing": [
{}
],
"duplicated": [
{}
]
}
}Inspect containers
Required capabilities:
dataModelsAcl:READ
POST
/
models
/
containers
/
inspect
Inspect containers
curl --request POST \
--url https://{cluster}.cognitedata.com/api/v1/projects/{project}/models/containers/inspect \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"inspectionOperations": {
"involvedViews": {
"allVersions": false
},
"totalInvolvedViewCount": {
"allVersions": false,
"includeUnavailableViews": true
}
},
"items": [
{
"space": "<string>",
"externalId": "<string>"
}
]
}
'import requests
url = "https://{cluster}.cognitedata.com/api/v1/projects/{project}/models/containers/inspect"
payload = {
"inspectionOperations": {
"involvedViews": { "allVersions": False },
"totalInvolvedViewCount": {
"allVersions": False,
"includeUnavailableViews": True
}
},
"items": [
{
"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({
inspectionOperations: {
involvedViews: {allVersions: false},
totalInvolvedViewCount: {allVersions: false, includeUnavailableViews: true}
},
items: [{space: '<string>', externalId: '<string>'}]
})
};
fetch('https://{cluster}.cognitedata.com/api/v1/projects/{project}/models/containers/inspect', 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/containers/inspect",
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([
'inspectionOperations' => [
'involvedViews' => [
'allVersions' => false
],
'totalInvolvedViewCount' => [
'allVersions' => false,
'includeUnavailableViews' => true
]
],
'items' => [
[
'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}/models/containers/inspect"
payload := strings.NewReader("{\n \"inspectionOperations\": {\n \"involvedViews\": {\n \"allVersions\": false\n },\n \"totalInvolvedViewCount\": {\n \"allVersions\": false,\n \"includeUnavailableViews\": true\n }\n },\n \"items\": [\n {\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}/models/containers/inspect")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"inspectionOperations\": {\n \"involvedViews\": {\n \"allVersions\": false\n },\n \"totalInvolvedViewCount\": {\n \"allVersions\": false,\n \"includeUnavailableViews\": true\n }\n },\n \"items\": [\n {\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}/models/containers/inspect")
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 \"inspectionOperations\": {\n \"involvedViews\": {\n \"allVersions\": false\n },\n \"totalInvolvedViewCount\": {\n \"allVersions\": false,\n \"includeUnavailableViews\": true\n }\n },\n \"items\": [\n {\n \"space\": \"<string>\",\n \"externalId\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"items": [
{
"externalId": "<string>",
"space": "<string>",
"inspectionResults": {
"involvedViewCount": 123,
"involvedViews": [
{
"type": "view",
"space": "<string>",
"externalId": "<string>",
"version": "<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
Which containers to inspect and the inspection operations to run.
Response
Containers along with the results of the inspection operations
List of container inspection results
Show child attributes
Show child attributes
Last modified on July 13, 2026
Was this page helpful?
⌘I