BazeField Services

<back to all web services

DomainPointMeasurementsSubscriptionPolledRefresh

Domain Data API
Requires Authentication
The following routes are available for this service:
GET, POST/api/objects/points/subscription/{handles}/measurementsReturns all values per schema since last refresh
DomainPointMeasurementsSubscriptionPolledRefresh Parameters:
NameParameterData TypeRequiredDescription
handlespathstring[]No
holdTimebodystringNo
waitTimebodyintNo
returnAllMeasurementsbodyboolNo
clientRequestHandlebodystringNo
DomainPointMeasurementsPolledRefreshResponse Parameters:
NameParameterData TypeRequiredDescription
MeasurementListformDomainPointMeasurementsPolledRefreshReply[]No
DataBufferOverflowformboolNo
BazefieldResponse Parameters:
NameParameterData TypeRequiredDescription
ReplyInfoformReplyInfoNo
ReplyInfo Parameters:
NameParameterData TypeRequiredDescription
RcvTimeformdoubleNo
ReplyTimeformdoubleNo
ClientRequestHandleformstringNo
ErrorformstringNo
DomainPointMeasurementsPolledRefreshReply Parameters:
NameParameterData TypeRequiredDescription
MeasurementsformObjectPointValueLocal[]No
ServerSubcriptionHandleformstringNo
ErrorformstringNo
ObjectPointValueLocal Parameters:
NameParameterData TypeRequiredDescription
AttributesformDictionary<string, string>No
ObjectPointValue Parameters:
NameParameterData TypeRequiredDescription
PointNameformstringNo
ObjectIdformstringNo
TimeSeriesValue Parameters:
NameParameterData TypeRequiredDescription
tformlongNo
qformintNo
vformObjectNo
t_localformDateTimeOffset?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/objects/points/subscription/{handles}/measurements HTTP/1.1 
Host: mdn.bazefield.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<DomainPointMeasurementsSubscriptionPolledRefresh xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Bazefield.Domain.Data.WebService.Request">
  <clientRequestHandle>String</clientRequestHandle>
  <handles xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </handles>
  <holdTime>String</holdTime>
  <returnAllMeasurements>false</returnAllMeasurements>
  <waitTime>0</waitTime>
</DomainPointMeasurementsSubscriptionPolledRefresh>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<DomainPointMeasurementsPolledRefreshResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Bazefield.Domain.Data.WebService.Response">
  <ReplyInfo xmlns="http://schemas.datacontract.org/2004/07/Bazefield.WebService.Common">
    <ClientRequestHandle>String</ClientRequestHandle>
    <Error>String</Error>
    <RcvTime>0</RcvTime>
    <ReplyTime>0</ReplyTime>
  </ReplyInfo>
  <DataBufferOverflow>false</DataBufferOverflow>
  <MeasurementList>
    <DomainPointMeasurementsPolledRefreshReply>
      <Error>String</Error>
      <Measurements xmlns:d4p1="http://schemas.datacontract.org/2004/07/Bazefield.Domain.Data.Entity">
        <d4p1:ObjectPointValueLocal>
          <q xmlns="http://schemas.datacontract.org/2004/07/BazeField.Historian.DataServices">0</q>
          <t xmlns="http://schemas.datacontract.org/2004/07/BazeField.Historian.DataServices">0</t>
          <t_local xmlns:d6p1="http://schemas.datacontract.org/2004/07/System" xmlns="http://schemas.datacontract.org/2004/07/BazeField.Historian.DataServices">
            <d6p1:DateTime>0001-01-01T00:00:00Z</d6p1:DateTime>
            <d6p1:OffsetMinutes>0</d6p1:OffsetMinutes>
          </t_local>
          <v xmlns="http://schemas.datacontract.org/2004/07/BazeField.Historian.DataServices" />
          <d4p1:ObjectId>String</d4p1:ObjectId>
          <d4p1:PointName>String</d4p1:PointName>
          <d4p1:Attributes xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:KeyValueOfstringstring>
              <d6p1:Key>String</d6p1:Key>
              <d6p1:Value>String</d6p1:Value>
            </d6p1:KeyValueOfstringstring>
          </d4p1:Attributes>
        </d4p1:ObjectPointValueLocal>
      </Measurements>
      <ServerSubcriptionHandle>String</ServerSubcriptionHandle>
    </DomainPointMeasurementsPolledRefreshReply>
  </MeasurementList>
</DomainPointMeasurementsPolledRefreshResponse>