Retrieve

async AsyncCogniteClient.data_modeling.time_series.retrieve(

node_ids: NodeId | tuple[str, str] | Sequence[NodeId] | Sequence[tuple[str, str]],

*,

source: View | ViewId | tuple[str, str, str] = ViewId(space='cdf_cdm', external_id='CogniteTimeSeries', version='v1'),

) → Node | NodeList[Node] | None

Retrieve one or more time series by instance ID.

Only nodes that are time series (i.e. have data in the CogniteTimeSeries view) will be returned. If a single instance ID is requested and it is not found, None is returned.

Parameters:

• node_ids (NodeId | tuple[str, str] | Sequence[NodeId] | Sequence[tuple[str, str]]) – Single instance ID or a list of instance IDs.

• source (View | ViewId | tuple[str, str, str]) – The view to fetch properties from. Defaults to CogniteTimeSeries.

Returns:

A single Node (or None if not found) when given a single identifier, or a NodeList when given a sequence.

Return type:

Node | NodeList[Node] | None

Examples

Retrieve a single time series by instance ID:

>>> from cognite.client import CogniteClient
>>> from cognite.client.data_classes.data_modeling import NodeId
>>> client = CogniteClient()
>>> res = client.data_modeling.time_series.retrieve(NodeId("my-space", "my-ts"))

Using a tuple shorthand:

>>> res = client.data_modeling.time_series.retrieve(("my-space", "my-ts"))

Retrieve multiple time series nodes:

>>> res = client.data_modeling.time_series.retrieve(
...     [("my-space", "ts-1"), ("my-space", "ts-2")]
... )

Fetch properties from a custom view (note, only time series will be returned):

>>> from cognite.client.data_classes.data_modeling import ViewId
>>> res = client.data_modeling.time_series.retrieve(
...     NodeId("my-space", "my-ts"),
...     source=ViewId("my-space", "MyTimeSeriesExtension", "v1"),
... )