JavaScript SDK
const retrievedFeatureTypes = await client.geospatial.featureType.retrieve([ { externalId: 'ocean_temperature' } ]);curl --request POST \
--url https://{cluster}.cognitedata.com/api/v1/projects/{project}/geospatial/featuretypes/byids \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"items": [
{
"externalId": "ocean_temperature"
}
]
}
'import requests
url = "https://{cluster}.cognitedata.com/api/v1/projects/{project}/geospatial/featuretypes/byids"
payload = { "items": [{ "externalId": "ocean_temperature" }] }
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}/geospatial/featuretypes/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' => [
[
'externalId' => 'ocean_temperature'
]
]
]),
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}/geospatial/featuretypes/byids"
payload := strings.NewReader("{\n \"items\": [\n {\n \"externalId\": \"ocean_temperature\"\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}/geospatial/featuretypes/byids")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"items\": [\n {\n \"externalId\": \"ocean_temperature\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{cluster}.cognitedata.com/api/v1/projects/{project}/geospatial/featuretypes/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 \"externalId\": \"ocean_temperature\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"items": [
{
"externalId": "ocean_temperature",
"dataSetId": 1278028,
"createdTime": 1629784673505,
"lastUpdatedTime": 1629784673505,
"properties": {
"temperature": {
"type": "DOUBLE"
},
"location": {
"type": "POINT",
"srid": 4326
},
"createdTime": {
"type": "LONG"
},
"lastUpdatedTime": {
"type": "LONG"
},
"externalId": {
"type": "STRING",
"size": 32
}
},
"searchSpec": {
"location_idx": {
"properties": [
"location"
]
},
"createdTimeIdx": {
"properties": [
"createdTime"
]
},
"lastUpdatedTimeIdx": {
"properties": [
"lastUpdatedTime"
]
},
"externalIdIdx": {
"properties": [
"externalId"
]
}
}
}
]
}{
"error": {
"code": 401,
"message": "Could not authenticate.",
"missing": [
{}
],
"duplicated": [
{}
],
"invalid": [
{}
],
"dependencies": [
{}
]
}
}Retrieve feature types
Required capabilities:
geospatialAcl:READ
Retrieves feature types by external ids. It is possible to retrieve up to 100 items per request, i.e. the maximum number of feature types for a tenant.
POST
/
geospatial
/
featuretypes
/
byids
JavaScript SDK
const retrievedFeatureTypes = await client.geospatial.featureType.retrieve([ { externalId: 'ocean_temperature' } ]);curl --request POST \
--url https://{cluster}.cognitedata.com/api/v1/projects/{project}/geospatial/featuretypes/byids \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"items": [
{
"externalId": "ocean_temperature"
}
]
}
'import requests
url = "https://{cluster}.cognitedata.com/api/v1/projects/{project}/geospatial/featuretypes/byids"
payload = { "items": [{ "externalId": "ocean_temperature" }] }
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}/geospatial/featuretypes/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' => [
[
'externalId' => 'ocean_temperature'
]
]
]),
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}/geospatial/featuretypes/byids"
payload := strings.NewReader("{\n \"items\": [\n {\n \"externalId\": \"ocean_temperature\"\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}/geospatial/featuretypes/byids")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"items\": [\n {\n \"externalId\": \"ocean_temperature\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{cluster}.cognitedata.com/api/v1/projects/{project}/geospatial/featuretypes/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 \"externalId\": \"ocean_temperature\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"items": [
{
"externalId": "ocean_temperature",
"dataSetId": 1278028,
"createdTime": 1629784673505,
"lastUpdatedTime": 1629784673505,
"properties": {
"temperature": {
"type": "DOUBLE"
},
"location": {
"type": "POINT",
"srid": 4326
},
"createdTime": {
"type": "LONG"
},
"lastUpdatedTime": {
"type": "LONG"
},
"externalId": {
"type": "STRING",
"size": 32
}
},
"searchSpec": {
"location_idx": {
"properties": [
"location"
]
},
"createdTimeIdx": {
"properties": [
"createdTime"
]
},
"lastUpdatedTimeIdx": {
"properties": [
"lastUpdatedTime"
]
},
"externalIdIdx": {
"properties": [
"externalId"
]
}
}
}
]
}{
"error": {
"code": 401,
"message": "Could not authenticate.",
"missing": [
{}
],
"duplicated": [
{}
],
"invalid": [
{}
],
"dependencies": [
{}
]
}
}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
Required array length:
1 - 100 elementsShow child attributes
Show child attributes
Response
Feature type list response.
Maximum array length:
100Show child attributes
Show child attributes
Last modified on July 10, 2026
Was this page helpful?
⌘I