Cognite Data Fusion API

Retrieve subscriptions

Retrieve one or more subscriptions by external ID.

Securityoidc-token or oauth2-client-credentials or oauth2-open-industrial-data or oauth2-auth-code

Request

Request Body schema: application/json
required

Specify a list of the subscriptions to retrieve.

required	Array of objects (QueryWithExternalId) = 1 items unique List of ID objects
ignoreUnknownIds	boolean Default: false Ignore IDs and external IDs that are not found

Responses

200

The retrieved subscriptions.

post/timeseries/subscriptions/byids

Request samples

Payload
Python SDK
curl

application/json

{"items": [{"externalId": "my.known.id"
}
],
"ignoreUnknownIds": false
}

Response samples

application/json

{"items": [{"externalId": "my.known.id",
"name": "string",
"description": "string",
"dataSetId": 1,
"partitionCount": 1,
"timeSeriesCount": 0,
"filter": {"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"
}
}
]
}
]
},
"createdTime": 1730204346000,
"lastUpdatedTime": 1730204346000
}
]
}

➔ Next to Update subscriptions

Retrieve subscriptions

Request Body schema: application/jsonrequired

Request Body schema: application/json
required