BazeField Services

ReadAggregatedTimeSeries

Measurement API

The following routes are available for this service:
GET,POST	/api/measurements/timeseries/aggregated
GET,POST	/api/measurements/{Keys}/aggregates/{Aggregates}/from/{From}/to/{To}/points/{NumPoints}	Obsolete
GET,POST	/api/measurements/{Keys}/aggregates/{Aggregates}/from/{From}/to/{To}/interval/{Interval}	Obsolete
GET,POST	/api/measurements/from/{From}/to/{To}/interval/{Interval}	Obsolete
GET,POST	/api/measurements/from/{From}/to/{To}/points/{NumPoints}	Obsolete

**ReadAggregatedTimeSeries** Parameters:
Name	Parameter	Data Type	Required
Keys	path	string[]	No
Aggregates	path	string[]	No
Interval	path	string	No
From	path	string	No
To	path	string	No
NumPoints	path	int?	No
Filter	body	string	No
Condition	body	string	No
MetaData	body	string	No
ClientRequestHandle	body	string	No
AlignToStartOfSubInterval	body	bool	No
SortByTagValue	body	string[]	No
InObjectTime	body	bool?	No

**ReadTimeSeriesReplyList** Parameters:
Name	Parameter	Data Type	Required
timeSeriesList	form	ReadTimeSeriesReply[]	No
startTime	form	double	No
endTime	form	double	No
replyInfo	form	ReplyInfo	No

**ReadTimeSeriesReply** Parameters:
Name	Parameter	Data Type	Required
measurementId	form	int	No
MeasurementName	form	string	No
Unit	form	string	No
aggregateType	form	int	No
timeSeries	form	TimeSeriesValue[]	No
resultId	form	int	No
error	form	string	No

**TimeSeriesValue** Parameters:
Name	Parameter	Data Type	Required
t	form	long	No
q	form	int	No
v	form	Object	No
t_local	form	DateTimeOffset?	No

**ReplyInfo** Parameters:
Name	Parameter	Data Type	Required
RcvTime	form	double	No
ReplyTime	form	double	No
ClientRequestHandle	form	string	No
Error	form	string	No

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /api/measurements/timeseries/aggregated HTTP/1.1 
Host: mdn.bazefield.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<ReadAggregatedTimeSeries xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BazeField.Historian.DataServices">
  <Aggregates xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Aggregates>
  <AlignToStartOfSubInterval>false</AlignToStartOfSubInterval>
  <ClientRequestHandle>String</ClientRequestHandle>
  <Condition>String</Condition>
  <Filter>String</Filter>
  <From>String</From>
  <InObjectTime>false</InObjectTime>
  <Interval>String</Interval>
  <Keys xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Keys>
  <MetaData>String</MetaData>
  <NumPoints>0</NumPoints>
  <SortByTagValue xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </SortByTagValue>
  <To>String</To>
</ReadAggregatedTimeSeries>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ReadTimeSeriesReplyList xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BazeField.Historian.DataServices">
  <endTime>0</endTime>
  <replyInfo xmlns:d2p1="http://schemas.datacontract.org/2004/07/Bazefield.WebService.Common">
    <d2p1:ClientRequestHandle>String</d2p1:ClientRequestHandle>
    <d2p1:Error>String</d2p1:Error>
    <d2p1:RcvTime>0</d2p1:RcvTime>
    <d2p1:ReplyTime>0</d2p1:ReplyTime>
  </replyInfo>
  <startTime>0</startTime>
  <timeSeriesList>
    <ReadTimeSeriesReply>
      <MeasurementName>String</MeasurementName>
      <Unit>String</Unit>
      <aggregateType>0</aggregateType>
      <error>String</error>
      <measurementId>0</measurementId>
      <resultId>0</resultId>
      <timeSeries>
        <TimeSeriesValue>
          <q>0</q>
          <t>0</t>
          <t_local xmlns:d6p1="http://schemas.datacontract.org/2004/07/System">
            <d6p1:DateTime>0001-01-01T00:00:00Z</d6p1:DateTime>
            <d6p1:OffsetMinutes>0</d6p1:OffsetMinutes>
          </t_local>
          <v />
        </TimeSeriesValue>
      </timeSeries>
    </ReadTimeSeriesReply>
  </timeSeriesList>
</ReadTimeSeriesReplyList>