GET api/timeseries/{objectKey}/objectType/{objectType}/typeClass/{typeClass}/resolution/{resolution}?from={from}&to={to}&utc={utc}
GET the timeseries for a objectkey as timeseries.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
objectKey |
Object key |
string |
Required |
objectType |
The object type |
ObjectType |
Required |
typeClass |
Timeseries type class |
TimeSeriesTypeClass |
Required |
resolution |
Resolution |
TimeSeriesResolution |
Required |
from |
From date in yyyy-MM-ddTHH:mm:ss format |
string |
Required |
to |
To date in yyyy-MM-ddTHH:mm:ss format |
string |
Required |
utc |
If values are in UTC |
boolean |
Default value is True |
Body Parameters
None.
Response Information
Resource Description
Timeseries contains list of values. Each value has a value and a timestamp.
TimeSerieName | Description | Type | Additional information |
---|---|---|---|
TimeSeriesTypeClass | TimeSeriesTypeClass |
None. |
|
Resolution | TimeSeriesResolution |
None. |
|
Values | Collection of TimeValue |
None. |
|
ObjectKey | string |
None. |
|
UnitType | string |
None. |
|
Unit | string |
None. |
Response Formats
application/json, text/json
Sample:
{ "TimeSeriesTypeClass": 1, "Resolution": 0, "Values": [ { "$id": "1", "ValueTime": "2025-05-19T19:33:12.2294391+00:00", "Value": 1.1, "Status": 1 }, { "$ref": "1" } ], "ObjectKey": "sample string 1", "UnitType": "sample string 2", "Unit": "sample string 3" }
text/html
Sample:
{"TimeSeriesTypeClass":1,"Resolution":0,"Values":[{"$id":"1","ValueTime":"2025-05-19T19:33:12.2294391+00:00","Value":1.1,"Status":1},{"$ref":"1"}],"ObjectKey":"sample string 1","UnitType":"sample string 2","Unit":"sample string 3"}