Python SDK
from cognite.client.data_classes import DataPointSubscriptionWrite
sub = DataPointSubscriptionWrite(
external_id="my_subscription",
name="My subscription",
partition_count=1,
time_series_ids=["myFistTimeSeries", "mySecondTimeSeries"])
created = client.time_series.subscriptions.create(sub)
from cognite.client.data_classes import DataPointSubscriptionWrite
from cognite.client.data_classes.data_modeling import NodeId
sub = DataPointSubscriptionWrite(
external_id="my_subscription",
name="My subscription with Data Model Ids",
partition_count=1,
instance_ids=[NodeId("my_space", "myFistTimeSeries"), NodeId("my_space", "mySecondTimeSeries")])
created = client.time_series.subscriptions.create(sub)
from cognite.client.data_classes import DataPointSubscriptionWrite
from cognite.client.data_classes import filters as flt
from cognite.client.data_classes.datapoints_subscriptions import DatapointSubscriptionProperty
is_numeric_stepwise = flt.And(
flt.Equals(DatapointSubscriptionProperty.is_string, False),
flt.Equals(DatapointSubscriptionProperty.is_step, True))
sub = DataPointSubscriptionWrite(
external_id="my_subscription",
name="My subscription for numeric, stepwise time series",
partition_count=1,
filter=is_numeric_stepwise)
created = client.time_series.subscriptions.create(sub)curl --request POST \
--url https://{cluster}.cognitedata.com/api/v1/projects/{project}/timeseries/subscriptions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"items": [
{
"externalId": "<string>",
"partitionCount": 50,
"name": "<string>",
"description": "<string>",
"dataSetId": 4503599627370496,
"timeSeriesIds": [
"my.known.id"
],
"instanceIds": [
{
"space": "<string>",
"externalId": "<string>"
}
],
"filter": {
"and": [
{
"or": [
{
"not": {
"and": [
{
"equals": {
"property": [
"metadata",
"manufacturer"
],
"value": "acme"
}
},
{
"in": {
"property": [
"name"
],
"values": [
"pump-1-temperature",
"motor-9-temperature"
]
}
},
{
"range": {
"property": [
"dataSetId"
],
"gte": 1,
"lt": 10
}
}
]
}
},
{
"and": [
{
"equals": {
"property": [
"assetId"
],
"value": 1234
}
},
{
"equals": {
"property": [
"description"
],
"value": "Temperature in Celsius"
}
}
]
}
]
}
]
}
}
]
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
items: [
{
externalId: '<string>',
partitionCount: 50,
name: '<string>',
description: '<string>',
dataSetId: 4503599627370496,
timeSeriesIds: ['my.known.id'],
instanceIds: [{space: '<string>', externalId: '<string>'}],
filter: {
and: [
{
or: [
{
not: {
and: [
{equals: {property: ['metadata', 'manufacturer'], value: 'acme'}},
{
in: {property: ['name'], values: ['pump-1-temperature', 'motor-9-temperature']}
},
{range: {property: ['dataSetId'], gte: 1, lt: 10}}
]
}
},
{
and: [
{equals: {property: ['assetId'], value: 1234}},
{equals: {property: ['description'], value: 'Temperature in Celsius'}}
]
}
]
}
]
}
}
]
})
};
fetch('https://{cluster}.cognitedata.com/api/v1/projects/{project}/timeseries/subscriptions', 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}/timeseries/subscriptions",
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' => '<string>',
'partitionCount' => 50,
'name' => '<string>',
'description' => '<string>',
'dataSetId' => 4503599627370496,
'timeSeriesIds' => [
'my.known.id'
],
'instanceIds' => [
[
'space' => '<string>',
'externalId' => '<string>'
]
],
'filter' => [
'and' => [
[
'or' => [
[
'not' => [
'and' => [
[
'equals' => [
'property' => [
'metadata',
'manufacturer'
],
'value' => 'acme'
]
],
[
'in' => [
'property' => [
'name'
],
'values' => [
'pump-1-temperature',
'motor-9-temperature'
]
]
],
[
'range' => [
'property' => [
'dataSetId'
],
'gte' => 1,
'lt' => 10
]
]
]
]
],
[
'and' => [
[
'equals' => [
'property' => [
'assetId'
],
'value' => 1234
]
],
[
'equals' => [
'property' => [
'description'
],
'value' => 'Temperature in Celsius'
]
]
]
]
]
]
]
]
]
]
]),
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}/timeseries/subscriptions"
payload := strings.NewReader("{\n \"items\": [\n {\n \"externalId\": \"<string>\",\n \"partitionCount\": 50,\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"dataSetId\": 4503599627370496,\n \"timeSeriesIds\": [\n \"my.known.id\"\n ],\n \"instanceIds\": [\n {\n \"space\": \"<string>\",\n \"externalId\": \"<string>\"\n }\n ],\n \"filter\": {\n \"and\": [\n {\n \"or\": [\n {\n \"not\": {\n \"and\": [\n {\n \"equals\": {\n \"property\": [\n \"metadata\",\n \"manufacturer\"\n ],\n \"value\": \"acme\"\n }\n },\n {\n \"in\": {\n \"property\": [\n \"name\"\n ],\n \"values\": [\n \"pump-1-temperature\",\n \"motor-9-temperature\"\n ]\n }\n },\n {\n \"range\": {\n \"property\": [\n \"dataSetId\"\n ],\n \"gte\": 1,\n \"lt\": 10\n }\n }\n ]\n }\n },\n {\n \"and\": [\n {\n \"equals\": {\n \"property\": [\n \"assetId\"\n ],\n \"value\": 1234\n }\n },\n {\n \"equals\": {\n \"property\": [\n \"description\"\n ],\n \"value\": \"Temperature in Celsius\"\n }\n }\n ]\n }\n ]\n }\n ]\n }\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}/timeseries/subscriptions")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"items\": [\n {\n \"externalId\": \"<string>\",\n \"partitionCount\": 50,\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"dataSetId\": 4503599627370496,\n \"timeSeriesIds\": [\n \"my.known.id\"\n ],\n \"instanceIds\": [\n {\n \"space\": \"<string>\",\n \"externalId\": \"<string>\"\n }\n ],\n \"filter\": {\n \"and\": [\n {\n \"or\": [\n {\n \"not\": {\n \"and\": [\n {\n \"equals\": {\n \"property\": [\n \"metadata\",\n \"manufacturer\"\n ],\n \"value\": \"acme\"\n }\n },\n {\n \"in\": {\n \"property\": [\n \"name\"\n ],\n \"values\": [\n \"pump-1-temperature\",\n \"motor-9-temperature\"\n ]\n }\n },\n {\n \"range\": {\n \"property\": [\n \"dataSetId\"\n ],\n \"gte\": 1,\n \"lt\": 10\n }\n }\n ]\n }\n },\n {\n \"and\": [\n {\n \"equals\": {\n \"property\": [\n \"assetId\"\n ],\n \"value\": 1234\n }\n },\n {\n \"equals\": {\n \"property\": [\n \"description\"\n ],\n \"value\": \"Temperature in Celsius\"\n }\n }\n ]\n }\n ]\n }\n ]\n }\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{cluster}.cognitedata.com/api/v1/projects/{project}/timeseries/subscriptions")
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\": \"<string>\",\n \"partitionCount\": 50,\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"dataSetId\": 4503599627370496,\n \"timeSeriesIds\": [\n \"my.known.id\"\n ],\n \"instanceIds\": [\n {\n \"space\": \"<string>\",\n \"externalId\": \"<string>\"\n }\n ],\n \"filter\": {\n \"and\": [\n {\n \"or\": [\n {\n \"not\": {\n \"and\": [\n {\n \"equals\": {\n \"property\": [\n \"metadata\",\n \"manufacturer\"\n ],\n \"value\": \"acme\"\n }\n },\n {\n \"in\": {\n \"property\": [\n \"name\"\n ],\n \"values\": [\n \"pump-1-temperature\",\n \"motor-9-temperature\"\n ]\n }\n },\n {\n \"range\": {\n \"property\": [\n \"dataSetId\"\n ],\n \"gte\": 1,\n \"lt\": 10\n }\n }\n ]\n }\n },\n {\n \"and\": [\n {\n \"equals\": {\n \"property\": [\n \"assetId\"\n ],\n \"value\": 1234\n }\n },\n {\n \"equals\": {\n \"property\": [\n \"description\"\n ],\n \"value\": \"Temperature in Celsius\"\n }\n }\n ]\n }\n ]\n }\n ]\n }\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"items": [
{
"externalId": "my.known.id",
"partitionCount": 50,
"createdTime": 1730204346000,
"lastUpdatedTime": 1730204346000,
"name": "<string>",
"description": "<string>",
"dataSetId": 4503599627370496,
"timeSeriesCount": 123,
"filter": {
"and": [
{
"or": [
{
"not": {
"and": [
{
"equals": {
"property": [
"metadata",
"manufacturer"
],
"value": "acme"
}
},
{
"in": {
"property": [
"name"
],
"values": [
"pump-1-temperature",
"motor-9-temperature"
]
}
},
{
"range": {
"property": [
"dataSetId"
],
"gte": 1,
"lt": 10
}
}
]
}
},
{
"and": [
{
"equals": {
"property": [
"assetId"
],
"value": 1234
}
},
{
"equals": {
"property": [
"description"
],
"value": "Temperature in Celsius"
}
}
]
}
]
}
]
}
}
]
}Create subscriptions
Required capabilities:
timeSeriesSubscriptionsAcl:WRITE
Create one or more subscriptions that can be used to listen for changes in data points for a set of time series.
POST
/
timeseries
/
subscriptions
Python SDK
from cognite.client.data_classes import DataPointSubscriptionWrite
sub = DataPointSubscriptionWrite(
external_id="my_subscription",
name="My subscription",
partition_count=1,
time_series_ids=["myFistTimeSeries", "mySecondTimeSeries"])
created = client.time_series.subscriptions.create(sub)
from cognite.client.data_classes import DataPointSubscriptionWrite
from cognite.client.data_classes.data_modeling import NodeId
sub = DataPointSubscriptionWrite(
external_id="my_subscription",
name="My subscription with Data Model Ids",
partition_count=1,
instance_ids=[NodeId("my_space", "myFistTimeSeries"), NodeId("my_space", "mySecondTimeSeries")])
created = client.time_series.subscriptions.create(sub)
from cognite.client.data_classes import DataPointSubscriptionWrite
from cognite.client.data_classes import filters as flt
from cognite.client.data_classes.datapoints_subscriptions import DatapointSubscriptionProperty
is_numeric_stepwise = flt.And(
flt.Equals(DatapointSubscriptionProperty.is_string, False),
flt.Equals(DatapointSubscriptionProperty.is_step, True))
sub = DataPointSubscriptionWrite(
external_id="my_subscription",
name="My subscription for numeric, stepwise time series",
partition_count=1,
filter=is_numeric_stepwise)
created = client.time_series.subscriptions.create(sub)curl --request POST \
--url https://{cluster}.cognitedata.com/api/v1/projects/{project}/timeseries/subscriptions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"items": [
{
"externalId": "<string>",
"partitionCount": 50,
"name": "<string>",
"description": "<string>",
"dataSetId": 4503599627370496,
"timeSeriesIds": [
"my.known.id"
],
"instanceIds": [
{
"space": "<string>",
"externalId": "<string>"
}
],
"filter": {
"and": [
{
"or": [
{
"not": {
"and": [
{
"equals": {
"property": [
"metadata",
"manufacturer"
],
"value": "acme"
}
},
{
"in": {
"property": [
"name"
],
"values": [
"pump-1-temperature",
"motor-9-temperature"
]
}
},
{
"range": {
"property": [
"dataSetId"
],
"gte": 1,
"lt": 10
}
}
]
}
},
{
"and": [
{
"equals": {
"property": [
"assetId"
],
"value": 1234
}
},
{
"equals": {
"property": [
"description"
],
"value": "Temperature in Celsius"
}
}
]
}
]
}
]
}
}
]
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
items: [
{
externalId: '<string>',
partitionCount: 50,
name: '<string>',
description: '<string>',
dataSetId: 4503599627370496,
timeSeriesIds: ['my.known.id'],
instanceIds: [{space: '<string>', externalId: '<string>'}],
filter: {
and: [
{
or: [
{
not: {
and: [
{equals: {property: ['metadata', 'manufacturer'], value: 'acme'}},
{
in: {property: ['name'], values: ['pump-1-temperature', 'motor-9-temperature']}
},
{range: {property: ['dataSetId'], gte: 1, lt: 10}}
]
}
},
{
and: [
{equals: {property: ['assetId'], value: 1234}},
{equals: {property: ['description'], value: 'Temperature in Celsius'}}
]
}
]
}
]
}
}
]
})
};
fetch('https://{cluster}.cognitedata.com/api/v1/projects/{project}/timeseries/subscriptions', 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}/timeseries/subscriptions",
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' => '<string>',
'partitionCount' => 50,
'name' => '<string>',
'description' => '<string>',
'dataSetId' => 4503599627370496,
'timeSeriesIds' => [
'my.known.id'
],
'instanceIds' => [
[
'space' => '<string>',
'externalId' => '<string>'
]
],
'filter' => [
'and' => [
[
'or' => [
[
'not' => [
'and' => [
[
'equals' => [
'property' => [
'metadata',
'manufacturer'
],
'value' => 'acme'
]
],
[
'in' => [
'property' => [
'name'
],
'values' => [
'pump-1-temperature',
'motor-9-temperature'
]
]
],
[
'range' => [
'property' => [
'dataSetId'
],
'gte' => 1,
'lt' => 10
]
]
]
]
],
[
'and' => [
[
'equals' => [
'property' => [
'assetId'
],
'value' => 1234
]
],
[
'equals' => [
'property' => [
'description'
],
'value' => 'Temperature in Celsius'
]
]
]
]
]
]
]
]
]
]
]),
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}/timeseries/subscriptions"
payload := strings.NewReader("{\n \"items\": [\n {\n \"externalId\": \"<string>\",\n \"partitionCount\": 50,\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"dataSetId\": 4503599627370496,\n \"timeSeriesIds\": [\n \"my.known.id\"\n ],\n \"instanceIds\": [\n {\n \"space\": \"<string>\",\n \"externalId\": \"<string>\"\n }\n ],\n \"filter\": {\n \"and\": [\n {\n \"or\": [\n {\n \"not\": {\n \"and\": [\n {\n \"equals\": {\n \"property\": [\n \"metadata\",\n \"manufacturer\"\n ],\n \"value\": \"acme\"\n }\n },\n {\n \"in\": {\n \"property\": [\n \"name\"\n ],\n \"values\": [\n \"pump-1-temperature\",\n \"motor-9-temperature\"\n ]\n }\n },\n {\n \"range\": {\n \"property\": [\n \"dataSetId\"\n ],\n \"gte\": 1,\n \"lt\": 10\n }\n }\n ]\n }\n },\n {\n \"and\": [\n {\n \"equals\": {\n \"property\": [\n \"assetId\"\n ],\n \"value\": 1234\n }\n },\n {\n \"equals\": {\n \"property\": [\n \"description\"\n ],\n \"value\": \"Temperature in Celsius\"\n }\n }\n ]\n }\n ]\n }\n ]\n }\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}/timeseries/subscriptions")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"items\": [\n {\n \"externalId\": \"<string>\",\n \"partitionCount\": 50,\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"dataSetId\": 4503599627370496,\n \"timeSeriesIds\": [\n \"my.known.id\"\n ],\n \"instanceIds\": [\n {\n \"space\": \"<string>\",\n \"externalId\": \"<string>\"\n }\n ],\n \"filter\": {\n \"and\": [\n {\n \"or\": [\n {\n \"not\": {\n \"and\": [\n {\n \"equals\": {\n \"property\": [\n \"metadata\",\n \"manufacturer\"\n ],\n \"value\": \"acme\"\n }\n },\n {\n \"in\": {\n \"property\": [\n \"name\"\n ],\n \"values\": [\n \"pump-1-temperature\",\n \"motor-9-temperature\"\n ]\n }\n },\n {\n \"range\": {\n \"property\": [\n \"dataSetId\"\n ],\n \"gte\": 1,\n \"lt\": 10\n }\n }\n ]\n }\n },\n {\n \"and\": [\n {\n \"equals\": {\n \"property\": [\n \"assetId\"\n ],\n \"value\": 1234\n }\n },\n {\n \"equals\": {\n \"property\": [\n \"description\"\n ],\n \"value\": \"Temperature in Celsius\"\n }\n }\n ]\n }\n ]\n }\n ]\n }\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{cluster}.cognitedata.com/api/v1/projects/{project}/timeseries/subscriptions")
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\": \"<string>\",\n \"partitionCount\": 50,\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"dataSetId\": 4503599627370496,\n \"timeSeriesIds\": [\n \"my.known.id\"\n ],\n \"instanceIds\": [\n {\n \"space\": \"<string>\",\n \"externalId\": \"<string>\"\n }\n ],\n \"filter\": {\n \"and\": [\n {\n \"or\": [\n {\n \"not\": {\n \"and\": [\n {\n \"equals\": {\n \"property\": [\n \"metadata\",\n \"manufacturer\"\n ],\n \"value\": \"acme\"\n }\n },\n {\n \"in\": {\n \"property\": [\n \"name\"\n ],\n \"values\": [\n \"pump-1-temperature\",\n \"motor-9-temperature\"\n ]\n }\n },\n {\n \"range\": {\n \"property\": [\n \"dataSetId\"\n ],\n \"gte\": 1,\n \"lt\": 10\n }\n }\n ]\n }\n },\n {\n \"and\": [\n {\n \"equals\": {\n \"property\": [\n \"assetId\"\n ],\n \"value\": 1234\n }\n },\n {\n \"equals\": {\n \"property\": [\n \"description\"\n ],\n \"value\": \"Temperature in Celsius\"\n }\n }\n ]\n }\n ]\n }\n ]\n }\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"items": [
{
"externalId": "my.known.id",
"partitionCount": 50,
"createdTime": 1730204346000,
"lastUpdatedTime": 1730204346000,
"name": "<string>",
"description": "<string>",
"dataSetId": 4503599627370496,
"timeSeriesCount": 123,
"filter": {
"and": [
{
"or": [
{
"not": {
"and": [
{
"equals": {
"property": [
"metadata",
"manufacturer"
],
"value": "acme"
}
},
{
"in": {
"property": [
"name"
],
"values": [
"pump-1-temperature",
"motor-9-temperature"
]
}
},
{
"range": {
"property": [
"dataSetId"
],
"gte": 1,
"lt": 10
}
}
]
}
},
{
"and": [
{
"equals": {
"property": [
"assetId"
],
"value": 1234
}
},
{
"equals": {
"property": [
"description"
],
"value": "Temperature in Celsius"
}
}
]
}
]
}
]
}
}
]
}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
The subscriptions to create.
Subscription definitions. A subscription may be configured explicitly with a list
of time series, or it may be a configured dynamically through a filter. The
subscription cannot change type later.
An explicit list must be manually updated by the user, while a filter will be updated
automatically whenever a time series is added/deleted/updated (eventually consistent).
The filter subscriptions uses the same syntax as advanced filters in the Filter time series
endpoint, with two exceptions: The field is named `filter` instead of `advancedFilter`,
and we do not support the `search` LeafFilter.
Advanced filtering
The filter
field lets you create complex filtering expressions that combine simple operations,
such as equals, prefix, and exists, by using the Boolean operators and, or, and not.
Filtering applies to basic fields as well as metadata. See the advancedFilter syntax in the request example.
Supported leaf filters
| Leaf filter | Supported fields | Description and example |
|---|---|---|
containsAll | Array type fields | Only includes results which contain all of the specified values. {"containsAll": {"property": ["property"], "values": [1, 2, 3]}} |
containsAny | Array type fields | Only includes results which contain at least one of the specified values. {"containsAny": {"property": ["property"], "values": [1, 2, 3]}} |
equals | Non-array type fields | Only includes results that are equal to the specified value. {"equals": {"property": ["property"], "value": "example"}} |
exists | All fields | Only includes results where the specified property exists (has a value). {"exists": {"property": ["property"]}} |
in | Non-array type fields | Only includes results that are equal to one of the specified values. {"in": {"property": ["property"], "values": [1, 2, 3]}} |
prefix | String type fields | Only includes results which start with the specified text. {"prefix": {"property": ["property"], "value": "example"}} |
range | Non-array type fields | Only includes results that fall within the specified range. {"range": {"property": ["property"], "gt": 1, "lte": 5}} Supported operators: gt, lt, gte, lte |
Supported properties
| Property | Type |
|---|---|
["description"] | string |
["externalId"] | string |
["metadata", "<someCustomKey>"] | string |
["name"] | string |
["unit"] | string |
["unitExternalId"] | string |
["unitQuantity"] | string |
["instanceId", "space"] | string |
["instanceId", "externalId"] | string |
["assetId"] | number |
["assetRootId"] | number |
["createdTime"] | number |
["dataSetId"] | number |
["id"] | number |
["lastUpdatedTime"] | number |
["isStep"] | Boolean |
["isString"] | Boolean |
["type"] | string |
Limits
- Filter query max depth: 10.
- Filter query max number of clauses: 100.
andandorclauses must have at least one element (and at most 99, since each element counts towards the total clause limit, and so does theand/orclause itself).- The
propertyarray of each leaf filter has the following limitations:- Number of elements in the array is 1 or 2.
- Elements must not be null or blank.
- Each element max length is 256 characters.
- The
propertyarray must match one of the existing properties (static top-level property or dynamic metadata property).
containsAll,containsAny, andinfiltervaluesarray size must be in the range [1, 100].containsAll,containsAny, andinfiltervaluesarray must contain elements of number or string type (matching the type of the given property).rangefilter must have at lest one ofgt,gte,lt,lteattributes. Butgtis mutually exclusive togte, whileltis mutually exclusive tolte.gt,gte,lt,ltein therangefilter must be of number or string type (matching the type of the given property).- The maximum length of the
valueof a leaf filter that is applied to a string property is 256.
Required array length:
1 elementShow child attributes
Show child attributes
Response
201 - application/json
A list of subscriptions that were created.
List of subscriptions.
Show child attributes
Show child attributes
Last modified on July 10, 2026
Was this page helpful?
⌘I