BazeField Services

ReadAggregatedTimeSeriesFiltered

Measurement API

The following routes are available for this service:
POST	/api/measurements/aggregates/filtered

**ReadAggregatedTimeSeriesFiltered** Parameters:
Name	Parameter	Data Type	Required
Filters	body	MeasurementAggregateFilter[]	No
Interval	body	string	No
From	body	string	No
To	body	string	No
NumPoints	body	int?	No
ClientRequestHandle	body	string	No

**MeasurementAggregateFilter** Parameters:
Name	Parameter	Data Type	Required
Keys	form	string[]	No
Aggregates	form	string[]	No
Filter	form	string	No
Condition	form	string	No
MetaData	form	string	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/aggregates/filtered HTTP/1.1 
Host: mdn.bazefield.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

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

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>