Interface TimeseriesFilter

Filter for listing time series

interface TimeseriesFilter {
    assetExternalIds?: string[];
    assetIds?: number[];
    assetSubtreeIds?: IdEither[];
    createdTime?: DateRange;
    dataSetIds?: IdEither[];
    externalIdPrefix?: string;
    isStep?: boolean;
    isString?: boolean;
    lastUpdatedTime?: DateRange;
    metadata?: Metadata;
    name?: string;
    rootAssetIds?: number[];
    unit?: string;
    unitExternalId?: string;
}

Hierarchy (view full)

Properties

assetExternalIds? assetIds? assetSubtreeIds? createdTime? dataSetIds? externalIdPrefix? isStep? isString? lastUpdatedTime? metadata? name? rootAssetIds? unit? unitExternalId?

Properties

OptionalassetExternalIds

assetExternalIds?: string[]

Asset External IDs of related equipment that this time series relates to.

OptionalassetIds

assetIds?: number[]

Get time series related to these assets. Takes [ 1 .. 100 ] unique items.

OptionalassetSubtreeIds

assetSubtreeIds?: IdEither[]

Only include timeseries that are related to an asset in a subtree rooted at any of these assetIds. If the total size of the given subtrees exceeds 100,000 assets, an error will be returned.

OptionalcreatedTime

createdTime?: DateRange

OptionaldataSetIds

dataSetIds?: IdEither[]

Only include assets that reference these specific dataSet IDs

OptionalexternalIdPrefix

externalIdPrefix?: string

OptionalisStep

isStep?: boolean

OptionalisString

isString?: boolean

OptionallastUpdatedTime

lastUpdatedTime?: DateRange

Optionalmetadata

metadata?: Metadata

Optionalname

name?: string

OptionalrootAssetIds

rootAssetIds?: number[]

Only include timeseries that have a related asset in a tree rooted at any of these root assetIds.

Optionalunit

unit?: string

OptionalunitExternalId

unitExternalId?: string

The physical unit of the time series (reference to unit catalog).

Settings

Member Visibility

On This Page

Properties