Interface ExternalTimeseries

Input type for creating a time series

interface ExternalTimeseries {
    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

Set a value for legacyName to allow applications using API v0.3, v04, v05, and v0.6 to access this time series. The legacy name is the human-readable name for the time series and is mapped to the name field used in API versions 0.3-0.6. The legacyName field value must be unique, and setting this value to an already existing value will return an error. We recommend that you set this field to the same value as externalId.

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