List available outputs - Cognite Docs

GET

/

3d

/

models

/

{modelId}

/

revisions

/

{revisionId}

/

outputs

List available outputs

curl --request GET \
  --url https://{cluster}.cognitedata.com/api/v1/projects/{project}/3d/models/{modelId}/revisions/{revisionId}/outputs \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://{cluster}.cognitedata.com/api/v1/projects/{project}/3d/models/{modelId}/revisions/{revisionId}/outputs"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{cluster}.cognitedata.com/api/v1/projects/{project}/3d/models/{modelId}/revisions/{revisionId}/outputs', 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/models/{modelId}/revisions/{revisionId}/outputs",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://{cluster}.cognitedata.com/api/v1/projects/{project}/3d/models/{modelId}/revisions/{revisionId}/outputs"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://{cluster}.cognitedata.com/api/v1/projects/{project}/3d/models/{modelId}/revisions/{revisionId}/outputs")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{cluster}.cognitedata.com/api/v1/projects/{project}/3d/models/{modelId}/revisions/{revisionId}/outputs")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "items": [
    {
      "format": "ept-pointcloud",
      "version": 1,
      "blobId": 4503599627370496
    }
  ]
}

Authorizations

Authorization

string

header

required

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

https://{cluster}.cognitedata.com/.default

oidc-token

https://{cluster}.cognitedata.com/.default

oauth2-client-credentials

https://api.cognitedata.com/.default

oauth2-open-industrial-data

https://{cluster}.cognitedata.com/.default

oauth2-auth-code

Path Parameters

modelId

integer<int64>

required

Model ID.

revisionId

integer<int64>

required

Revision ID.

Query Parameters

format

string

Format identifier, e.g. 'ept-pointcloud' (point cloud). Well known formats are: 'ept-pointcloud' (point cloud data) or 'reveal-directory' (output supported by Reveal). 'all-outputs' can be used to retrieve all outputs for a 3D revision. Note that some of the outputs are internal, where the format and availability might change without warning.

Response

200 - application/json

Returns a list of outputs and available versions per output for the given revision.

items

object[]

required

A list of named and versioned outputs for the model. Note that the list is not sorted.

Show child attributes

⌘I

List available outputs

curl --request GET \
  --url https://{cluster}.cognitedata.com/api/v1/projects/{project}/3d/models/{modelId}/revisions/{revisionId}/outputs \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://{cluster}.cognitedata.com/api/v1/projects/{project}/3d/models/{modelId}/revisions/{revisionId}/outputs"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{cluster}.cognitedata.com/api/v1/projects/{project}/3d/models/{modelId}/revisions/{revisionId}/outputs', 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/models/{modelId}/revisions/{revisionId}/outputs",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://{cluster}.cognitedata.com/api/v1/projects/{project}/3d/models/{modelId}/revisions/{revisionId}/outputs"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://{cluster}.cognitedata.com/api/v1/projects/{project}/3d/models/{modelId}/revisions/{revisionId}/outputs")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{cluster}.cognitedata.com/api/v1/projects/{project}/3d/models/{modelId}/revisions/{revisionId}/outputs")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "items": [
    {
      "format": "ept-pointcloud",
      "version": 1,
      "blobId": 4503599627370496
    }
  ]
}