Interface TimeSeriesCreate

interface TimeSeriesCreate {
    assetId?: number;
    dataSetId?: number;
    description?: string;
    externalId?: string;
    isStep?: boolean;
    isString?: boolean;
    legacyName?: string;
    metadata?: Metadata;
    name?: string;
    securityCategories?: number[];
    unit?: string;
    unitExternalId?: string;
}

Properties

assetId? dataSetId? description? externalId? isStep? isString? legacyName? metadata? name? securityCategories? unit? unitExternalId?

Properties

OptionalassetId

assetId?: number

Asset that this time series belongs to.

OptionaldataSetId

dataSetId?: number

DataSet that this time series related with.

Optionaldescription

description?: string

Description of the time series.

OptionalexternalId

externalId?: string

Externally provided id for the time series (optional but recommended)

OptionalisStep

isStep?: boolean

Whether the time series is a step series or not.

OptionalisString

isString?: boolean

Whether the time series is string valued or not.

OptionallegacyName

legacyName?: string

Deprecated

This field is deprecated and ignored by the API.

Optionalmetadata

metadata?: Metadata

Additional metadata. String key -> String value.

Optionalname

name?: string

Human readable name of time series

OptionalsecurityCategories

securityCategories?: number[]

Security categories required in order to access this time series.

Optionalunit

unit?: string

The physical unit of the time series.

OptionalunitExternalId

unitExternalId?: string

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

Settings

Member Visibility

On This Page

Properties