Skip to content
Documentation

Finding Time Series

The PowerTSM .NET API provides the functionality to find stored time series by several search options.

Searching for time series in general is easy and can be done like this:

using System.Collections.Generic;
using HAKOM.TSM.Net.Api;
using HAKOM.TSM.Net.Api.TimeSeries;
var tsm = ITsm.Create();
var repository = await tsm.Repositories.Load("TSM_Example_Repository");
var timeSeriesStore = await repository.GetTimeSeriesStore();
IAsyncEnumerable<ITimeSeries> listOfTimeSeries = timeSeriesStore.Find();

By default a search only returns the time series themselves. Passing includeAttributes: true extends each result with the attributes assigned to the time series and their values, loaded in the same database query instead of one additional query per found time series.

When includeAttributes is set, the returned references implement IResolvedTimeSeriesReferenceWithAttributeData, which exposes the assigned attributes through AssignedAttributeData:

var results = timeSeriesStore.Find(
includeAttributes: true,
parameters: timeSeriesStore.SearchParameters.Create(name: "?Oil*")
);
await foreach (var result in results)
{
if (result is IResolvedTimeSeriesReferenceWithAttributeData withAttributes)
{
foreach (IAssignedAttributeData assigned in withAttributes.AssignedAttributeData)
{
// assigned.Attribute: reference to the assigned attribute
// assigned.Unit: selected unit, null unless the attribute is of type "List"
// assigned.Data: the attribute's values, empty if the attribute is assigned without values
}
}
}

includeAttributes can be combined with all other search options (filters, wildcards, attribute filters, limits and sorting).

Searching for a time series with certain configurations is possible as well. Finding all time series which are Cyclic and StepLeft can be done like this:

var searchParameters = timeSeriesStore.SearchParameters.Create(
cyclic: true,
function: FunctionType.StepLeft()
);
var listOfTimeSeries = timeSeriesStore.Find(searchParameters);

The filter supports wildcards specifically for searching time series by Name and Description. Supported wildcards are:

Symbol Meaning
? Wildcard for a single character
* Wildcard for multiple characters

Having a list of time series with the names 1OilAtEurope, 14OilAtEurope, 1OilAtAustralia, 1GasAtAustralia and 1GasAtAsia, the name search parameter ?Oil* would return the time series with the names 1OilAtEurope and 1OilAtAustralia.

The code for using a wildcard should look like this:

ITimeSeriesSearchParameters searchParameters = timeSeriesStore.SearchParameters.Create(
name: "?Oil*"
);
var listOfTimeSeries = timeSeriesStore.Find(searchParameters);

Time series can be looked for by assigned attributes and attribute values like this:

var timeSeriesWithLocation = timeSeriesStore.Find(
timeSeriesStore.SearchParameters.CreateWithAttributeCollection(
attributeSearchParametersCollections: [
timeSeriesStore.SearchParameters.AttributeSearchParameters.Create([
timeSeriesStore.SearchParameters.AttributeSearchParameters.Create("Location")
])
]
)
);
var timeSeriesWithLocationDACH = timeSeriesStore.Find(
timeSeriesStore.SearchParameters.CreateWithAttributeCollection(
attributeSearchParametersCollections: [
timeSeriesStore.SearchParameters.AttributeSearchParameters.Create([
timeSeriesStore.SearchParameters.AttributeSearchParameters.Create("Location", "AT"),
timeSeriesStore.SearchParameters.AttributeSearchParameters.Create("Location", "CH"),
timeSeriesStore.SearchParameters.AttributeSearchParameters.Create("Location", "DE")
])
]
)
);
var timeSeriesThatStillUseCoal = timeSeriesStore.Find(
timeSeriesStore.SearchParameters.CreateWithAttributeCollection(
attributeSearchParametersCollections: [
timeSeriesStore.SearchParameters.AttributeSearchParameters.Create([
timeSeriesStore.SearchParameters.AttributeSearchParameters.Create(
"Type",
"Coal",
Period.Create(
new DateTimeOffset(2025, 2, 10, 10, 0, 0, TimeSpan.Zero),
DateTimeOffset.MaxValue
)
)
])
]
)
);

Finding time series and configuring how the list is sorted is possible by setting the sortingOptions.

var sortingOptions = new ITimeSeriesSortingOptions[] { timeSeriesStore.SortingOptions.ByStartOfTime(), timeSeriesStore.SortingOptions.ByName() };
var listOfTimeSeries = timeSeriesStore.Find(sortingOptions: sortingOptions);

Finding time series but limiting the output is possible by setting a rangeStart and/or a rangeEnd like this:

var listOfTimeSeries = timeSeriesStore.Find(rangeStart: 2, rangeEnd: 10);

All above options to search for time series may be combined.

using HAKOM.TSM.Net.Api;
using HAKOM.TSM.Net.Api.TimeSeries.Persistence;
var tsm = ITsm.Create();
var repository = await tsm.Repositories.Load("TSM_Example_Repository");
var timeSeriesStore = await repository.GetTimeSeriesStore();
ITimeSeriesSearchParameters searchParameters = timeSeriesStore.SearchParameters.Create(
name: "?Oil*"
);
var sortingOptions = new ITimeSeriesSortingOptions[] {
timeSeriesStore.SortingOptions.ByStartOfTime(),
timeSeriesStore.SortingOptions.ByName()
};
var listOfTimeSeries = timeSeriesStore.Find(searchParameters, 2, 8, sortingOptions);

This would find the 2nd to 8th time series that match the given name, sorted by the provided SortingOptions.

© 2026 Volue.Version v0.6.38017 November 2026