BazeField Services

DomainPointsSubscribeRequest

Domain Data API

The following routes are available for this service:
GET, POST	/api/objects/points/subscribe	Registers a subscription. Returns handle id and current value for all schemas and points
GET, POST	/api/objects/{ObjectIds}/points/{points}/subscribe	Obsolete

**DomainPointsSubscribeRequest** Parameters:
Name	Parameter	Data Type	Required
ObjectIds	path	List<string>	No
Points	path	List<string>	No
Fields	body	List<string>	No
EnableBuffering	body	bool	No
RequestedSamplingRate	body	int?	No
SubscriptionPingRate	body	int?	No
ClientRequestHandle	body	string	No
mdmids	body	List<string>	No

**DomainPointsSubscribeResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Result	form	Dictionary<string, DomainPointValues>	No
ServerSubcriptionHandle	form	string	No

**BazefieldResponse** Parameters:
Name	Parameter	Data Type	Required	Description
ReplyInfo	form	ReplyInfo	No

**ReplyInfo** Parameters:
Name	Parameter	Data Type	Required
RcvTime	form	double	No
ReplyTime	form	double	No
ClientRequestHandle	form	string	No
Error	form	string	No

**DomainPointValues** Parameters:
Name	Parameter	Data Type	Required	Description
Points	form	Dictionary<string, ObjectPointValueLocal>	No

**ObjectPointValueLocal** Parameters:
Name	Parameter	Data Type	Required	Description
Attributes	form	Dictionary<string, string>	No

**ObjectPointValue** Parameters:
Name	Parameter	Data Type	Required	Description
PointName	form	string	No
ObjectId	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

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

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: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	objectIds: 
	[
		String
	],
	points: 
	[
		String
	],
	fields: 
	[
		String
	],
	enableBuffering: False,
	requestedSamplingRate: 0,
	subscriptionPingRate: 0,
	clientRequestHandle: String,
	mdmids: 
	[
		String
	]
}

HTTP/1.1 200 OK
Content-Type: text/jsv
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
				}
			}
		}
	},
	serverSubcriptionHandle: String,
	replyInfo: 
	{
		rcvTime: 0,
		replyTime: 0,
		clientRequestHandle: String,
		error: String
	}
}