BazeField Services

<back to all web services

DomainPointsSubscriptionPolledRefresh

Domain Data API
Requires Authentication
The following routes are available for this service:
GET, POST/api/objects/points/subscription/{handles}Returns maximum a single value per schema since last refresh
DomainPointsSubscriptionPolledRefresh Parameters:
NameParameterData TypeRequiredDescription
handlespathstring[]No
holdTimebodystringNo
waitTimebodyintNo
returnAllMeasurementsbodyboolNo
clientRequestHandlebodystringNo
DomainPointsPolledRefreshResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformDictionary<string, DomainPointValues>No
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 .csv suffix or ?format=csv

HTTP + CSV

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

POST /api/objects/points/subscription/{handles} HTTP/1.1 
Host: mdn.bazefield.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"handles":["String"],"holdTime":"String","waitTime":0,"returnAllMeasurements":false,"clientRequestHandle":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"result":{"String":{"points":{"String":{"attributes":{"String":"String"},"pointName":"String","objectId":"String","t":0,"q":0,"v":{},"t_local":"0001-01-01T00:00:00.0000000+00:00"}}}},"replyInfo":{"rcvTime":0,"replyTime":0,"clientRequestHandle":"String","error":"String"}}