BazeField Services

<back to all web services

ReadTimeSeries

Measurement API
Requires Authentication
The following routes are available for this service:
GET,POST/api/measurements/timeseries
GET/api/measurements/{Keys}/from/{From}/to/{To}Obsolete
GET,POST/api/measurements/{Keys}/from/{From}/to/{To}/points/{NumPoints}Obsolete
ReadTimeSeries Parameters:
NameParameterData TypeRequiredDescription
Keyspathstring[]No
FrompathstringNo
TopathstringNo
NumPointspathintNo
IncludeBoundsbodyboolNo
MetaDatabodystringNo
ClientRequestHandlebodystringNo
InObjectTimebodybool?No
ReadTimeSeriesReplyList Parameters:
NameParameterData TypeRequiredDescription
timeSeriesListformReadTimeSeriesReply[]No
startTimeformdoubleNo
endTimeformdoubleNo
replyInfoformReplyInfoNo
ReadTimeSeriesReply Parameters:
NameParameterData TypeRequiredDescription
measurementIdformintNo
MeasurementNameformstringNo
UnitformstringNo
aggregateTypeformintNo
timeSeriesformTimeSeriesValue[]No
resultIdformintNo
errorformstringNo
TimeSeriesValue Parameters:
NameParameterData TypeRequiredDescription
tformlongNo
qformintNo
vformObjectNo
t_localformDateTimeOffset?No
ReplyInfo Parameters:
NameParameterData TypeRequiredDescription
RcvTimeformdoubleNo
ReplyTimeformdoubleNo
ClientRequestHandleformstringNo
ErrorformstringNo

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 HTTP/1.1 
Host: mdn.bazefield.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<ReadTimeSeries xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BazeField.Historian.DataServices">
  <ClientRequestHandle>String</ClientRequestHandle>
  <From>String</From>
  <InObjectTime>false</InObjectTime>
  <IncludeBounds>false</IncludeBounds>
  <Keys xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Keys>
  <MetaData>String</MetaData>
  <NumPoints>0</NumPoints>
  <To>String</To>
</ReadTimeSeries>
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>