Interface TimeSeries

interface TimeSeries {
    assetId?: number;
    createdTime: Date;
    dataSetId?: number;
    description: string;
    externalId?: string;
    id: number;
    instanceId?: CogniteInstanceId;
    isStep: boolean;
    isString: boolean;
    lastUpdatedTime: Date;
    metadata?: Metadata;
    name?: string;
    securityCategories?: number[];
    type?: TimeSeriesType;
    unit?: string;
    unitExternalId?: string;
}

Hierarchy (view full)

Properties

assetId? createdTime dataSetId? description externalId? id instanceId? isStep isString lastUpdatedTime metadata? name? securityCategories? type? unit? unitExternalId?

Properties

OptionalassetId

assetId?: number

Asset that this time series belongs to.

createdTime

createdTime: Date

OptionaldataSetId

dataSetId?: number

description

description: string

OptionalexternalId

externalId?: string

Externally supplied id of the time series

id

id: number

OptionalinstanceId

instanceId?: CogniteInstanceId

The ID of an instance in Cognite Data Models.

isStep

isStep: boolean

isString

isString: boolean

lastUpdatedTime

lastUpdatedTime: Date

Optionalmetadata

metadata?: Metadata

Additional metadata. String key -> String value.

Optionalname

name?: string

OptionalsecurityCategories

securityCategories?: number[]

Security categories required in order to access this time series.

Optionaltype

type?: TimeSeriesType

Optionalunit

unit?: string

OptionalunitExternalId

unitExternalId?: string

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

Settings

Member Visibility

On This Page

Properties