Skip to content
Documentation

ITimeSeriesSearchParameters Interface

Parameters for searching time series.

public interface ITimeSeriesSearchParameters

ITimeSeriesSearchParameters.AttributeSearchParameters Property

Section titled “ITimeSeriesSearchParameters.AttributeSearchParameters Property”

Filter for time series by assigned IAttribute.

System.Collections.Generic.IEnumerable<HAKOM.TSM.Net.Api.TimeSeries.Persistence.ITimeSeriesAttributeSearchParameters> AttributeSearchParameters { get; }

System.Collections.Generic.IEnumerable<ITimeSeriesAttributeSearchParameters>

ITimeSeriesSearchParameters.AttributeSearchParametersCollections Property

Section titled “ITimeSeriesSearchParameters.AttributeSearchParametersCollections Property”

Filter for time series by assigned IAttribute. Each of these ITimeSeriesAttributeSearchParametersCollection will be connected with the logical AND when the search criteria are determined.

System.Collections.Generic.IEnumerable<HAKOM.TSM.Net.Api.TimeSeries.Persistence.ITimeSeriesAttributeSearchParametersCollection> AttributeSearchParametersCollections { get; }

System.Collections.Generic.IEnumerable<ITimeSeriesAttributeSearchParametersCollection>

ITimeSeriesSearchParameters.ChangedSince Property

Section titled “ITimeSeriesSearchParameters.ChangedSince Property”

Filter for time series whose definition, attribute assignments, attribute data or time series assignments were last changed at or after this point in time. null disables the filter.

System.Nullable<System.DateTimeOffset> ChangedSince { get; }

System.Nullable<System.DateTimeOffset>

The comparison is inclusive and uses the resolution of the repository’s TimeBase.

Writing time series data does not count as a change. A modification that fails part-way or changes nothing may also be counted.

Saving a time series definition through ITimeSeriesStore with an explicit historic date and time sets its last-changed time to that point in time, even if it is earlier than the previous one.

ITimeSeriesSearchParameters.Cyclic Property

Section titled “ITimeSeriesSearchParameters.Cyclic Property”

Filter for time series by it being ‘cyclic’ or not.

System.Nullable<bool> Cyclic { get; set; }

System.Nullable<System.Boolean>

ITimeSeriesSearchParameters.Description Property

Section titled “ITimeSeriesSearchParameters.Description Property”

Filter for time series by the content of their Description. Wildcard characters may be used.
Possible wildcards are:

  • ‘*’ = substitutes 0 or more of any characters
  • ‘?’ = substitutes 1 character

The wildcards can be escaped with a backslash ‘\’.

string? Description { get; set; }

System.String

ITimeSeriesSearchParameters.Formula Property

Section titled “ITimeSeriesSearchParameters.Formula Property”

Filter for time series by their IFormula.

HAKOM.TSM.Net.Api.Formulas.IFormula? Formula { get; set; }

IFormula

ITimeSeriesSearchParameters.Function Property

Section titled “ITimeSeriesSearchParameters.Function Property”

Filter for time series by their FunctionType.

System.Nullable<HAKOM.TSM.Net.Api.TimeSeries.FunctionType> Function { get; set; }

System.Nullable<FunctionType>

ITimeSeriesSearchParameters.Interval Property

Section titled “ITimeSeriesSearchParameters.Interval Property”

Filter for time series by their IInterval.

HAKOM.TSM.Net.Api.Time.Intervals.IInterval? Interval { get; set; }

IInterval

ITimeSeriesSearchParameters.IntervalMultiplier Property

Section titled “ITimeSeriesSearchParameters.IntervalMultiplier Property”

Filter for time series by their Multiplier.

System.Nullable<int> IntervalMultiplier { get; set; }

System.Nullable<System.Int32>

ITimeSeriesSearchParameters.IntervalTransformationMethod Property

Section titled “ITimeSeriesSearchParameters.IntervalTransformationMethod Property”

Filter for time series by their IntervalTransformationMethod.

System.Nullable<HAKOM.TSM.Net.Api.Time.Intervals.IntervalTransformationMethod> IntervalTransformationMethod { get; set; }

System.Nullable<IntervalTransformationMethod>

ITimeSeriesSearchParameters.IntervalType Property

Section titled “ITimeSeriesSearchParameters.IntervalType Property”

Filter for time series by their Type.

System.Nullable<HAKOM.TSM.Net.Api.Time.Intervals.IntervalType> IntervalType { get; set; }

System.Nullable<IntervalType>

Filter for time series by their Name. Wildcard characters may be used.
Possible wildcards are:

  • ‘*’ = substitutes 0 or more of any characters
  • ‘?’ = substitutes 1 character

The wildcards can be escaped with a backslash ‘\’.

string? Name { get; set; }

System.String

ITimeSeriesSearchParameters.StartOfTime Property

Section titled “ITimeSeriesSearchParameters.StartOfTime Property”

Filter for time series by their StartOfTime.

System.Nullable<System.DateTimeOffset> StartOfTime { get; set; }

System.Nullable<System.DateTimeOffset>

ITimeSeriesSearchParameters.TimeZone Property

Section titled “ITimeSeriesSearchParameters.TimeZone Property”

Filter for time series by their ITimeZone.

HAKOM.TSM.Net.Api.Time.TimeZones.ITimeZone? TimeZone { get; set; }

ITimeZone

Filter for time series by their IUnitReference.

HAKOM.TSM.Net.Api.Units.Persistence.References.IUnitReference? Unit { get; set; }

IUnitReference

© 2026 Volue.Version v0.6.38017 November 2026