| GET, POST | /api/objects/timeseries/aggregated | Gets aggregated timeseries data for objects |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ObjectIds | body | List<string> | No | |
| Points | body | List<string> | No | |
| Aggregates | body | List<string> | Yes | Legal aggration type, e.g. AVERAGE, TIMEAVERAGE, START, END, etc. |
| Fields | body | List<string> | No | |
| From | body | string | Yes | Javascript time, shorthand notation like * (now), *d (start of today), *d-1d (start of yesterday), etc. or ISO time |
| To | body | string | Yes | Javascript time, shorthand notation like * (now), *d (start of today), *d-1d (start of yesterday), etc. or ISO time |
| Interval | body | string | No | |
| ExpectHdaCompatible | body | bool? | No | |
| InObjectTime | body | bool? | No | |
| DataFilter | body | string | No | |
| Conditions | body | string | No | |
| QueryOptions | body | string | No | |
| ClientRequestHandle | body | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Objects | form | Dictionary<string, DomainPointTimeSeries> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ReplyInfo | form | ReplyInfo | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| RcvTime | form | double | No | |
| ReplyTime | form | double | No | |
| ClientRequestHandle | form | string | No | |
| Error | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Points | form | Dictionary<string, List<ObjectPointTimeSeries>> | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /api/objects/timeseries/aggregated HTTP/1.1
Host: mdn.bazefield.com
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"objectIds":["String"],"points":["String"],"aggregates":["String"],"fields":["String"],"from":"String","to":"String","interval":"String","expectHdaCompatible":false,"inObjectTime":false,"dataFilter":"String","conditions":"String","queryOptions":"String","clientRequestHandle":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"objects":{"String":{"points":{"String":[{"objectId":"String","pointName":"String","aggregate":"String","timeSeries":[{"t":0,"q":0,"v":{},"t_local":"0001-01-01T00:00:00.0000000+00:00"}],"from":"0001-01-01T00:00:00.0000000","to":"0001-01-01T00:00:00.0000000","interval":"String","attributes":{"String":"String"},"resultId":0,"error":"String","isHdaCompatible":false}]}}},"replyInfo":{"rcvTime":0,"replyTime":0,"clientRequestHandle":"String","error":"String"}}