BazeField Services

<back to all web services

DomainPointsSubscribeRequest

Domain Data API
Requires Authentication
The following routes are available for this service:
GET, POST/api/objects/points/subscribeRegisters a subscription. Returns handle id and current value for all schemas and points
GET, POST/api/objects/{ObjectIds}/points/{points}/subscribeObsolete
DomainPointsSubscribeRequest Parameters:
NameParameterData TypeRequiredDescription
ObjectIdspathList<string>No
PointspathList<string>No
FieldsbodyList<string>No
EnableBufferingbodyboolNo
RequestedSamplingRatebodyint?No
SubscriptionPingRatebodyint?No
ClientRequestHandlebodystringNo
mdmidsbodyList<string>No
DomainPointsSubscribeResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformDictionary<string, DomainPointValues>No
ServerSubcriptionHandleformstringNo
BazefieldResponse Parameters:
NameParameterData TypeRequiredDescription
ReplyInfoformReplyInfoNo
ReplyInfo Parameters:
NameParameterData TypeRequiredDescription
RcvTimeformdoubleNo
ReplyTimeformdoubleNo
ClientRequestHandleformstringNo
ErrorformstringNo
DomainPointValues Parameters:
NameParameterData TypeRequiredDescription
PointsformDictionary<string, ObjectPointValueLocal>No
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/subscribe HTTP/1.1 
Host: mdn.bazefield.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<DomainPointsSubscribeRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Bazefield.Domain.Data.WebService.Request">
  <ClientRequestHandle>String</ClientRequestHandle>
  <EnableBuffering>false</EnableBuffering>
  <Fields xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Fields>
  <ObjectIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </ObjectIds>
  <Points xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Points>
  <RequestedSamplingRate>0</RequestedSamplingRate>
  <SubscriptionPingRate>0</SubscriptionPingRate>
  <mdmids xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </mdmids>
</DomainPointsSubscribeRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<DomainPointsSubscribeResponse 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>
  <Result xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringDomainPointValuesdG1LNjhA>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value xmlns:d4p1="http://schemas.datacontract.org/2004/07/Bazefield.Domain.Data.Entity">
        <d4p1:Points>
          <d2p1:KeyValueOfstringObjectPointValueLocaldG1LNjhA>
            <d2p1:Key>String</d2p1:Key>
            <d2p1:Value>
              <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:d8p1="http://schemas.datacontract.org/2004/07/System" xmlns="http://schemas.datacontract.org/2004/07/BazeField.Historian.DataServices">
                <d8p1:DateTime>0001-01-01T00:00:00Z</d8p1:DateTime>
                <d8p1:OffsetMinutes>0</d8p1: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>
                <d2p1:KeyValueOfstringstring>
                  <d2p1:Key>String</d2p1:Key>
                  <d2p1:Value>String</d2p1:Value>
                </d2p1:KeyValueOfstringstring>
              </d4p1:Attributes>
            </d2p1:Value>
          </d2p1:KeyValueOfstringObjectPointValueLocaldG1LNjhA>
        </d4p1:Points>
      </d2p1:Value>
    </d2p1:KeyValueOfstringDomainPointValuesdG1LNjhA>
  </Result>
  <ServerSubcriptionHandle>String</ServerSubcriptionHandle>
</DomainPointsSubscribeResponse>