JavaScript SDK
const dataSets = await client.datasets.retrieve([{id: 123}, {externalId: 'abc'}]);res = client.data_sets.retrieve(id=1)
res = client.data_sets.retrieve(external_id="1")
res = client.data_sets.retrieve_multiple(ids=[1, 2, 3])
res = client.data_sets.retrieve_multiple(external_ids=["abc", "def"], ignore_unknown_ids=True)List<Item> retrieveByExternalIds = List.of(Item.newBuilder()
.setExternalId("10")
.build());
List<DataSet> retrieveDataSetResults = client.datasets()
.retrieve(retrieveByExternalIds);//by list of items
List<DataSet> retrieveDataSetResults = client.datasets()
.retrieve("10", "20");//by varargs of String
List<Item> retrieveByInternalIds = List.of(Item.newBuilder()
.setId(10)
.build());
List<DataSet> retrieveDataSetResults = client.datasets()
.retrieve(retrieveByInternalIds);//by list of items
List<DataSet> retrieveDataSetResults = client.datasets()
.retrieve(10, 20);//by varargs of Longcurl --request POST \
--url https://{cluster}.cognitedata.com/api/v1/projects/{project}/datasets/byids \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"items": [
{
"id": 4503599627370496
}
],
"ignoreUnknownIds": false
}
'<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{cluster}.cognitedata.com/api/v1/projects/{project}/datasets/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' => [
[
'id' => 4503599627370496
]
],
'ignoreUnknownIds' => false
]),
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}/datasets/byids"
payload := strings.NewReader("{\n \"items\": [\n {\n \"id\": 4503599627370496\n }\n ],\n \"ignoreUnknownIds\": false\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))
}require 'uri'
require 'net/http'
url = URI("https://{cluster}.cognitedata.com/api/v1/projects/{project}/datasets/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 \"id\": 4503599627370496\n }\n ],\n \"ignoreUnknownIds\": false\n}"
response = http.request(request)
puts response.read_body{
"items": [
{
"writeProtected": false,
"id": 4503599627370496,
"createdTime": 1730204346000,
"lastUpdatedTime": 1730204346000,
"externalId": "my.known.id",
"name": "<string>",
"description": "<string>",
"metadata": {}
}
]
}{
"error": {
"code": 401,
"message": "Could not authenticate.",
"missing": [
{}
],
"duplicated": [
{}
]
}
}Retrieve data sets
Required capabilities:
datasetsAcl:READ
Retrieve data sets by IDs or external IDs.
POST
/
datasets
/
byids
JavaScript SDK
const dataSets = await client.datasets.retrieve([{id: 123}, {externalId: 'abc'}]);res = client.data_sets.retrieve(id=1)
res = client.data_sets.retrieve(external_id="1")
res = client.data_sets.retrieve_multiple(ids=[1, 2, 3])
res = client.data_sets.retrieve_multiple(external_ids=["abc", "def"], ignore_unknown_ids=True)List<Item> retrieveByExternalIds = List.of(Item.newBuilder()
.setExternalId("10")
.build());
List<DataSet> retrieveDataSetResults = client.datasets()
.retrieve(retrieveByExternalIds);//by list of items
List<DataSet> retrieveDataSetResults = client.datasets()
.retrieve("10", "20");//by varargs of String
List<Item> retrieveByInternalIds = List.of(Item.newBuilder()
.setId(10)
.build());
List<DataSet> retrieveDataSetResults = client.datasets()
.retrieve(retrieveByInternalIds);//by list of items
List<DataSet> retrieveDataSetResults = client.datasets()
.retrieve(10, 20);//by varargs of Longcurl --request POST \
--url https://{cluster}.cognitedata.com/api/v1/projects/{project}/datasets/byids \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"items": [
{
"id": 4503599627370496
}
],
"ignoreUnknownIds": false
}
'<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{cluster}.cognitedata.com/api/v1/projects/{project}/datasets/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' => [
[
'id' => 4503599627370496
]
],
'ignoreUnknownIds' => false
]),
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}/datasets/byids"
payload := strings.NewReader("{\n \"items\": [\n {\n \"id\": 4503599627370496\n }\n ],\n \"ignoreUnknownIds\": false\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))
}require 'uri'
require 'net/http'
url = URI("https://{cluster}.cognitedata.com/api/v1/projects/{project}/datasets/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 \"id\": 4503599627370496\n }\n ],\n \"ignoreUnknownIds\": false\n}"
response = http.request(request)
puts response.read_body{
"items": [
{
"writeProtected": false,
"id": 4503599627370496,
"createdTime": 1730204346000,
"lastUpdatedTime": 1730204346000,
"externalId": "my.known.id",
"name": "<string>",
"description": "<string>",
"metadata": {}
}
]
}{
"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
List of the IDs of the data sets to retrieve. You can retrieve a maximum of 1000 data sets per request. All IDs must be unique.
Response
A list of data sets.
Show child attributes
Show child attributes
Last modified on July 10, 2026
Was this page helpful?
⌘I