Filter sequences - Cognite Docs

POST

sequences

list

JavaScript SDK

const sequences = await client.sequences.list({ filter: { name: 'sequence_name' } });

from cognite.client.data_classes import filters
asset_filter = filters.Equals("asset_id", 123)
is_efficiency = filters.Equals(["metadata", "type"], "efficiency")
res = client.sequences.filter(filter=filters.And(asset_filter, is_efficiency), sort="created_time")

from cognite.client.data_classes import filters
from cognite.client.data_classes.sequences import SequenceProperty, SortableSequenceProperty
asset_filter = filters.Equals(SequenceProperty.asset_id, 123)
is_efficiency = filters.Equals(SequenceProperty.metadata_key("type"), "efficiency")
res = client.sequences.filter(
    filter=filters.And(asset_filter, is_efficiency),
    sort=SortableSequenceProperty.created_time)
res = client.sequences.list(limit=5)

for seq in client.sequences:
    seq # do something with the sequence

for seq_list in client.sequences(chunk_size=2500):
    seq_list # do something with the sequences

from cognite.client.data_classes import filters
in_timezone = filters.Prefix(["metadata", "timezone"], "Europe")
res = client.sequences.list(advanced_filter=in_timezone, sort=("external_id", "asc"))

from cognite.client.data_classes import filters
from cognite.client.data_classes.sequences import SequenceProperty, SortableSequenceProperty
in_timezone = filters.Prefix(SequenceProperty.metadata_key("timezone"), "Europe")
res = client.sequences.list(
    advanced_filter=in_timezone,
    sort=(SortableSequenceProperty.external_id, "asc"))

from cognite.client.data_classes import filters
not_instrument_lvl5 = filters.And(
   filters.ContainsAny("labels", ["Level5"]),
   filters.Not(filters.ContainsAny("labels", ["Instrument"]))
)
res = client.sequences.list(asset_subtree_ids=[123456], advanced_filter=not_instrument_lvl5)

List<SequenceMetadata> listSequencesResults = new ArrayList<>(); 
 client.sequences() 
          .list() 
          .forEachRemaining(sequences -> listSequencesResults.addAll(sequences)); 

 client.sequences() 
          .list(Request.create() 
               .withFilterMetadataParameter("source", "sdk-data-generator")) 
          .forEachRemaining(sequences -> listSequencesResults.addAll(sequences)); 

curl --request POST \
  --url https://{cluster}.cognitedata.com/api/v1/projects/{project}/sequences/list \
  --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
      }
    ]
  },
  "advancedFilter": {
    "and": "<array>"
  },
  "limit": 100,
  "cursor": "4zj0Vy2fo0NtNMb229mI9r1V3YG5NBL752kQz1cKtwo",
  "partition": "1/10",
  "sort": [
    {
      "property": [
        "<string>"
      ],
      "nulls": "auto"
    }
  ]
}
'

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{cluster}.cognitedata.com/api/v1/projects/{project}/sequences/list",
  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
                ]
        ]
    ],
    'advancedFilter' => [
        'and' => '<array>'
    ],
    'limit' => 100,
    'cursor' => '4zj0Vy2fo0NtNMb229mI9r1V3YG5NBL752kQz1cKtwo',
    'partition' => '1/10',
    'sort' => [
        [
                'property' => [
                                '<string>'
                ],
                'nulls' => 'auto'
        ]
    ]
  ]),
  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/list"

	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  \"advancedFilter\": {\n    \"and\": \"<array>\"\n  },\n  \"limit\": 100,\n  \"cursor\": \"4zj0Vy2fo0NtNMb229mI9r1V3YG5NBL752kQz1cKtwo\",\n  \"partition\": \"1/10\",\n  \"sort\": [\n    {\n      \"property\": [\n        \"<string>\"\n      ],\n      \"nulls\": \"auto\"\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))

}

require 'uri'
require 'net/http'

url = URI("https://{cluster}.cognitedata.com/api/v1/projects/{project}/sequences/list")

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  \"advancedFilter\": {\n    \"and\": \"<array>\"\n  },\n  \"limit\": 100,\n  \"cursor\": \"4zj0Vy2fo0NtNMb229mI9r1V3YG5NBL752kQz1cKtwo\",\n  \"partition\": \"1/10\",\n  \"sort\": [\n    {\n      \"property\": [\n        \"<string>\"\n      ],\n      \"nulls\": \"auto\"\n    }\n  ]\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
    }
  ],
  "nextCursor": "<string>"
}

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

Body

application/json

Retrieves a list of sequences matching the given criteria.

Cursor for paging through results. In general, if a response contains a nextCursor property, it means that there may be more results, and you should pass that value as the cursor parameter in the next request.

Note that the cursor may or may not be encrypted, but either way, it is not intended to be decoded. Its internal structure is not a part of the public API, and may change without notice. You should treat it as an opaque string and not attempt to craft your own cursors.

filter

object

Show child attributes

advancedFilter

and · object

A query that matches items matching boolean combinations of other queries. It is built by nesting one or more Boolean clauses, each of which is one of and, or, and not. Each such clause contains one or more child clauses (though not can only have one). Each child clause can be either another Boolean clause or a leaf filter.

Show child attributes

limit

integer<int32>

default:100

Returns up to this many results per page.

Required range: 1 <= x <= 1000

cursor

string

Example:

"4zj0Vy2fo0NtNMb229mI9r1V3YG5NBL752kQz1cKtwo"

partition

string

Splits the data set into N partitions. The attribute is specified as a "M/N" string, where M is a natural number in the interval of [1, N]. You need to follow the cursors within each partition in order to receive all the data.

To prevent unexpected problems and maximize read throughput, you should at most use 10 (N <= 10) partitions.

When using more than 10 partitions, CDF may reduce the number of partitions silently. For example, CDF may reduce the number of partitions to K = 10 so if you specify an X/N partition value where X = 8 and N = 20 - i.e. "partition": "8/20"- then CDF will change N to N = K = 10 and process the request. But if you specify the X/N partition value where X = 11 (X > K) and N = 20 - i.e. "partition": "11/20"- then CDF will reply with an empty result list and no cursor in the response.\

In future releases of the resource APIs, Cognite may reject requests if you specify more than 10 partitions. When Cognite enforces this behavior, the requests will result in a 400 Bad Request status.

Example:

"1/10"

sort

object[]

Sort by array of selected properties.

Required array length: 1 - 2 elements

Show child attributes

Response

200 - application/json

Response with a list of sequences matching the given criteria.

items

object[]

required

Show child attributes

nextCursor

string

The cursor to get the next page of results (if available). Learn more about pagination.

⌘I

JavaScript SDK

const sequences = await client.sequences.list({ filter: { name: 'sequence_name' } });

from cognite.client.data_classes import filters
asset_filter = filters.Equals("asset_id", 123)
is_efficiency = filters.Equals(["metadata", "type"], "efficiency")
res = client.sequences.filter(filter=filters.And(asset_filter, is_efficiency), sort="created_time")

from cognite.client.data_classes import filters
from cognite.client.data_classes.sequences import SequenceProperty, SortableSequenceProperty
asset_filter = filters.Equals(SequenceProperty.asset_id, 123)
is_efficiency = filters.Equals(SequenceProperty.metadata_key("type"), "efficiency")
res = client.sequences.filter(
    filter=filters.And(asset_filter, is_efficiency),
    sort=SortableSequenceProperty.created_time)
res = client.sequences.list(limit=5)

for seq in client.sequences:
    seq # do something with the sequence

for seq_list in client.sequences(chunk_size=2500):
    seq_list # do something with the sequences

from cognite.client.data_classes import filters
in_timezone = filters.Prefix(["metadata", "timezone"], "Europe")
res = client.sequences.list(advanced_filter=in_timezone, sort=("external_id", "asc"))

from cognite.client.data_classes import filters
from cognite.client.data_classes.sequences import SequenceProperty, SortableSequenceProperty
in_timezone = filters.Prefix(SequenceProperty.metadata_key("timezone"), "Europe")
res = client.sequences.list(
    advanced_filter=in_timezone,
    sort=(SortableSequenceProperty.external_id, "asc"))

from cognite.client.data_classes import filters
not_instrument_lvl5 = filters.And(
   filters.ContainsAny("labels", ["Level5"]),
   filters.Not(filters.ContainsAny("labels", ["Instrument"]))
)
res = client.sequences.list(asset_subtree_ids=[123456], advanced_filter=not_instrument_lvl5)

List<SequenceMetadata> listSequencesResults = new ArrayList<>(); 
 client.sequences() 
          .list() 
          .forEachRemaining(sequences -> listSequencesResults.addAll(sequences)); 

 client.sequences() 
          .list(Request.create() 
               .withFilterMetadataParameter("source", "sdk-data-generator")) 
          .forEachRemaining(sequences -> listSequencesResults.addAll(sequences)); 

curl --request POST \
  --url https://{cluster}.cognitedata.com/api/v1/projects/{project}/sequences/list \
  --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
      }
    ]
  },
  "advancedFilter": {
    "and": "<array>"
  },
  "limit": 100,
  "cursor": "4zj0Vy2fo0NtNMb229mI9r1V3YG5NBL752kQz1cKtwo",
  "partition": "1/10",
  "sort": [
    {
      "property": [
        "<string>"
      ],
      "nulls": "auto"
    }
  ]
}
'

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{cluster}.cognitedata.com/api/v1/projects/{project}/sequences/list",
  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
                ]
        ]
    ],
    'advancedFilter' => [
        'and' => '<array>'
    ],
    'limit' => 100,
    'cursor' => '4zj0Vy2fo0NtNMb229mI9r1V3YG5NBL752kQz1cKtwo',
    'partition' => '1/10',
    'sort' => [
        [
                'property' => [
                                '<string>'
                ],
                'nulls' => 'auto'
        ]
    ]
  ]),
  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/list"

	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  \"advancedFilter\": {\n    \"and\": \"<array>\"\n  },\n  \"limit\": 100,\n  \"cursor\": \"4zj0Vy2fo0NtNMb229mI9r1V3YG5NBL752kQz1cKtwo\",\n  \"partition\": \"1/10\",\n  \"sort\": [\n    {\n      \"property\": [\n        \"<string>\"\n      ],\n      \"nulls\": \"auto\"\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))

}

require 'uri'
require 'net/http'

url = URI("https://{cluster}.cognitedata.com/api/v1/projects/{project}/sequences/list")

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  \"advancedFilter\": {\n    \"and\": \"<array>\"\n  },\n  \"limit\": 100,\n  \"cursor\": \"4zj0Vy2fo0NtNMb229mI9r1V3YG5NBL752kQz1cKtwo\",\n  \"partition\": \"1/10\",\n  \"sort\": [\n    {\n      \"property\": [\n        \"<string>\"\n      ],\n      \"nulls\": \"auto\"\n    }\n  ]\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
    }
  ],
  "nextCursor": "<string>"
}