ValueTimeSeries class

Represents base class for time series of measurements. It is used for passing time series data between various modules. Starting with Byington, we are making this as concrete class and this will be persisted in Database.

ValueTimeSeries class APIs

The following tables list the basic APIs, operation APIs, and relationship APIs for the ValueTimeSeries class.

Basic APIs

Name

HTTP
method

URI

Description

search

POST

csm/ValueTimeSeries/search

Searches for ValueTimeSeries objects.

Operation APIs

The ValueTimeSeries class has no operation APIs.

Relationship APIs

The ValueTimeSeries class has no relationship APIs.

ValueTimeSeries class relationships and attributes

The following tables list the relationships and attributes of the ValueTimeSeries class.

Relationships

Name

Type

Multi-
plicity

Description

valueTimes

ValueTime

0..*

cloudClass

CloudClass

1

Fully-qualified name of the class to which the object belongs

provider

Provider

1

Provider that created the object

tags

Tag

0..*

Tags associated with the object

Attributes

Name

Type

Multi-
plicity

Description

customSummarizationPeriodValue

Integer

0..1

When summarizationPeriod is 'Custom', this field defines summarization period.

endTimestamp

Date

0..1

Last time stamp of time range for which data points are requested or returned.

startTimestamp

Date

0..1

Starting time stamp of time range for which data points are requested or returned.

statisticalModifier

StatisticalModifier

1

Indicates whether data points are Raw, Average, Min, Max or Delta. Statisticalmodifier applies to data points in given summarization period.

status

ValueTimeSeriesStatus

0..1

statusReason

String

0..1

summarizationPeriod

SummarizationPeriod

1

Period over which data points are summarized.

timestamps

Date

0..*

Array of timestamps. Each time stamp corresponds to element in values with same index.
Starting with Byington release, this field has been deprecated in favor of a new explicit relationship to class ValueTime, which represents a value against time. The ValueTimeSeries now points to list of TimeValue objects.

description

String

0..1

Text that describes the object

guid

String

1

Globally unique identifier for the object

labels

String

0..*

modifiedDate

Date

0..1

Date the Cloudobject was modified

name

String

1

Human-readable name of the object

Was this page helpful? Yes No Submitting... Thank you

Comments