JavaScript SDK
const sequences = await client.sequences.search({
filter: {
assetIds: [1, 2]
},
search: {
query: 'n*m* desc*ion'
}
});res = client.sequences.search(name="some name")curl --request POST \
--url https://{cluster}.cognitedata.com/api/v1/projects/{project}/sequences/search \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"filter": {
"name": "<string>",
"externalIdPrefix": "my.known.prefix",
"metadata": {
"key1": "value1",
"key2": "value2"
},
"assetIds": [
363848954441724,
793045462540095,
1261042166839739
],
"rootAssetIds": [
363848954441724,
793045462540095,
1261042166839739
],
"assetSubtreeIds": [
{
"id": 1234567890
},
{
"externalId": "externalId123"
}
],
"createdTime": {
"max": 1,
"min": 1
},
"lastUpdatedTime": {
"max": 1,
"min": 1
},
"dataSetIds": [
{
"id": 4503599627370496
}
]
},
"search": {
"name": "<string>",
"description": "<string>",
"query": "<string>"
},
"limit": 100
}
'<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{cluster}.cognitedata.com/api/v1/projects/{project}/sequences/search",
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([
'filter' => [
'name' => '<string>',
'externalIdPrefix' => 'my.known.prefix',
'metadata' => [
'key1' => 'value1',
'key2' => 'value2'
],
'assetIds' => [
363848954441724,
793045462540095,
1261042166839739
],
'rootAssetIds' => [
363848954441724,
793045462540095,
1261042166839739
],
'assetSubtreeIds' => [
[
'id' => 1234567890
],
[
'externalId' => 'externalId123'
]
],
'createdTime' => [
'max' => 1,
'min' => 1
],
'lastUpdatedTime' => [
'max' => 1,
'min' => 1
],
'dataSetIds' => [
[
'id' => 4503599627370496
]
]
],
'search' => [
'name' => '<string>',
'description' => '<string>',
'query' => '<string>'
],
'limit' => 100
]),
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}/sequences/search"
payload := strings.NewReader("{\n \"filter\": {\n \"name\": \"<string>\",\n \"externalIdPrefix\": \"my.known.prefix\",\n \"metadata\": {\n \"key1\": \"value1\",\n \"key2\": \"value2\"\n },\n \"assetIds\": [\n 363848954441724,\n 793045462540095,\n 1261042166839739\n ],\n \"rootAssetIds\": [\n 363848954441724,\n 793045462540095,\n 1261042166839739\n ],\n \"assetSubtreeIds\": [\n {\n \"id\": 1234567890\n },\n {\n \"externalId\": \"externalId123\"\n }\n ],\n \"createdTime\": {\n \"max\": 1,\n \"min\": 1\n },\n \"lastUpdatedTime\": {\n \"max\": 1,\n \"min\": 1\n },\n \"dataSetIds\": [\n {\n \"id\": 4503599627370496\n }\n ]\n },\n \"search\": {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"query\": \"<string>\"\n },\n \"limit\": 100\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}/sequences/search")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"filter\": {\n \"name\": \"<string>\",\n \"externalIdPrefix\": \"my.known.prefix\",\n \"metadata\": {\n \"key1\": \"value1\",\n \"key2\": \"value2\"\n },\n \"assetIds\": [\n 363848954441724,\n 793045462540095,\n 1261042166839739\n ],\n \"rootAssetIds\": [\n 363848954441724,\n 793045462540095,\n 1261042166839739\n ],\n \"assetSubtreeIds\": [\n {\n \"id\": 1234567890\n },\n {\n \"externalId\": \"externalId123\"\n }\n ],\n \"createdTime\": {\n \"max\": 1,\n \"min\": 1\n },\n \"lastUpdatedTime\": {\n \"max\": 1,\n \"min\": 1\n },\n \"dataSetIds\": [\n {\n \"id\": 4503599627370496\n }\n ]\n },\n \"search\": {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"query\": \"<string>\"\n },\n \"limit\": 100\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{cluster}.cognitedata.com/api/v1/projects/{project}/sequences/search")
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 \"filter\": {\n \"name\": \"<string>\",\n \"externalIdPrefix\": \"my.known.prefix\",\n \"metadata\": {\n \"key1\": \"value1\",\n \"key2\": \"value2\"\n },\n \"assetIds\": [\n 363848954441724,\n 793045462540095,\n 1261042166839739\n ],\n \"rootAssetIds\": [\n 363848954441724,\n 793045462540095,\n 1261042166839739\n ],\n \"assetSubtreeIds\": [\n {\n \"id\": 1234567890\n },\n {\n \"externalId\": \"externalId123\"\n }\n ],\n \"createdTime\": {\n \"max\": 1,\n \"min\": 1\n },\n \"lastUpdatedTime\": {\n \"max\": 1,\n \"min\": 1\n },\n \"dataSetIds\": [\n {\n \"id\": 4503599627370496\n }\n ]\n },\n \"search\": {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"query\": \"<string>\"\n },\n \"limit\": 100\n}"
response = http.request(request)
puts response.read_body{
"items": [
{
"id": 1,
"columns": [
{
"valueType": "DOUBLE",
"createdTime": 100000000000,
"lastUpdatedTime": 100000000000,
"name": "depth",
"externalId": "DPS1",
"description": "Optional description",
"metadata": {
"extracted-by": "cognite"
}
}
],
"createdTime": 100000000000,
"lastUpdatedTime": 100000000000,
"name": "Any relevant name",
"description": "Optional description",
"assetId": 1221123111,
"externalId": "my.known.id",
"metadata": {
"extracted-by": "cognite"
},
"dataSetId": 2718281828459
}
]
}Required capabilities:
sequencesAcl:READ
Retrieves a list of sequences matching the given criteria. This operation doesn’t support pagination.
POST
/
sequences
/
search
JavaScript SDK
const sequences = await client.sequences.search({
filter: {
assetIds: [1, 2]
},
search: {
query: 'n*m* desc*ion'
}
});res = client.sequences.search(name="some name")curl --request POST \
--url https://{cluster}.cognitedata.com/api/v1/projects/{project}/sequences/search \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"filter": {
"name": "<string>",
"externalIdPrefix": "my.known.prefix",
"metadata": {
"key1": "value1",
"key2": "value2"
},
"assetIds": [
363848954441724,
793045462540095,
1261042166839739
],
"rootAssetIds": [
363848954441724,
793045462540095,
1261042166839739
],
"assetSubtreeIds": [
{
"id": 1234567890
},
{
"externalId": "externalId123"
}
],
"createdTime": {
"max": 1,
"min": 1
},
"lastUpdatedTime": {
"max": 1,
"min": 1
},
"dataSetIds": [
{
"id": 4503599627370496
}
]
},
"search": {
"name": "<string>",
"description": "<string>",
"query": "<string>"
},
"limit": 100
}
'<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{cluster}.cognitedata.com/api/v1/projects/{project}/sequences/search",
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([
'filter' => [
'name' => '<string>',
'externalIdPrefix' => 'my.known.prefix',
'metadata' => [
'key1' => 'value1',
'key2' => 'value2'
],
'assetIds' => [
363848954441724,
793045462540095,
1261042166839739
],
'rootAssetIds' => [
363848954441724,
793045462540095,
1261042166839739
],
'assetSubtreeIds' => [
[
'id' => 1234567890
],
[
'externalId' => 'externalId123'
]
],
'createdTime' => [
'max' => 1,
'min' => 1
],
'lastUpdatedTime' => [
'max' => 1,
'min' => 1
],
'dataSetIds' => [
[
'id' => 4503599627370496
]
]
],
'search' => [
'name' => '<string>',
'description' => '<string>',
'query' => '<string>'
],
'limit' => 100
]),
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}/sequences/search"
payload := strings.NewReader("{\n \"filter\": {\n \"name\": \"<string>\",\n \"externalIdPrefix\": \"my.known.prefix\",\n \"metadata\": {\n \"key1\": \"value1\",\n \"key2\": \"value2\"\n },\n \"assetIds\": [\n 363848954441724,\n 793045462540095,\n 1261042166839739\n ],\n \"rootAssetIds\": [\n 363848954441724,\n 793045462540095,\n 1261042166839739\n ],\n \"assetSubtreeIds\": [\n {\n \"id\": 1234567890\n },\n {\n \"externalId\": \"externalId123\"\n }\n ],\n \"createdTime\": {\n \"max\": 1,\n \"min\": 1\n },\n \"lastUpdatedTime\": {\n \"max\": 1,\n \"min\": 1\n },\n \"dataSetIds\": [\n {\n \"id\": 4503599627370496\n }\n ]\n },\n \"search\": {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"query\": \"<string>\"\n },\n \"limit\": 100\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}/sequences/search")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"filter\": {\n \"name\": \"<string>\",\n \"externalIdPrefix\": \"my.known.prefix\",\n \"metadata\": {\n \"key1\": \"value1\",\n \"key2\": \"value2\"\n },\n \"assetIds\": [\n 363848954441724,\n 793045462540095,\n 1261042166839739\n ],\n \"rootAssetIds\": [\n 363848954441724,\n 793045462540095,\n 1261042166839739\n ],\n \"assetSubtreeIds\": [\n {\n \"id\": 1234567890\n },\n {\n \"externalId\": \"externalId123\"\n }\n ],\n \"createdTime\": {\n \"max\": 1,\n \"min\": 1\n },\n \"lastUpdatedTime\": {\n \"max\": 1,\n \"min\": 1\n },\n \"dataSetIds\": [\n {\n \"id\": 4503599627370496\n }\n ]\n },\n \"search\": {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"query\": \"<string>\"\n },\n \"limit\": 100\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{cluster}.cognitedata.com/api/v1/projects/{project}/sequences/search")
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 \"filter\": {\n \"name\": \"<string>\",\n \"externalIdPrefix\": \"my.known.prefix\",\n \"metadata\": {\n \"key1\": \"value1\",\n \"key2\": \"value2\"\n },\n \"assetIds\": [\n 363848954441724,\n 793045462540095,\n 1261042166839739\n ],\n \"rootAssetIds\": [\n 363848954441724,\n 793045462540095,\n 1261042166839739\n ],\n \"assetSubtreeIds\": [\n {\n \"id\": 1234567890\n },\n {\n \"externalId\": \"externalId123\"\n }\n ],\n \"createdTime\": {\n \"max\": 1,\n \"min\": 1\n },\n \"lastUpdatedTime\": {\n \"max\": 1,\n \"min\": 1\n },\n \"dataSetIds\": [\n {\n \"id\": 4503599627370496\n }\n ]\n },\n \"search\": {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"query\": \"<string>\"\n },\n \"limit\": 100\n}"
response = http.request(request)
puts response.read_body{
"items": [
{
"id": 1,
"columns": [
{
"valueType": "DOUBLE",
"createdTime": 100000000000,
"lastUpdatedTime": 100000000000,
"name": "depth",
"externalId": "DPS1",
"description": "Optional description",
"metadata": {
"extracted-by": "cognite"
}
}
],
"createdTime": 100000000000,
"lastUpdatedTime": 100000000000,
"name": "Any relevant name",
"description": "Optional description",
"assetId": 1221123111,
"externalId": "my.known.id",
"metadata": {
"extracted-by": "cognite"
},
"dataSetId": 2718281828459
}
]
}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
Retrieves a list of sequences matching the given criteria. This operation doesn't support pagination.
Response
200 - application/json
Response with a list of sequences matching the given criteria.
Show child attributes
Show child attributes
Last modified on July 10, 2026
Was this page helpful?
⌘I