BazeField Services

ReadTimeSeries

Measurement API

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:
Name	Parameter	Data Type	Required
Keys	path	string[]	No
From	path	string	No
To	path	string	No
NumPoints	path	int	No
IncludeBounds	body	bool	No
MetaData	body	string	No
ClientRequestHandle	body	string	No
InObjectTime	body	bool?	No

**ReadTimeSeriesReplyList** Parameters:
Name	Parameter	Data Type	Required
timeSeriesList	form	ReadTimeSeriesReply[]	No
startTime	form	double	No
endTime	form	double	No
replyInfo	form	ReplyInfo	No

**ReadTimeSeriesReply** Parameters:
Name	Parameter	Data Type	Required
measurementId	form	int	No
MeasurementName	form	string	No
Unit	form	string	No
aggregateType	form	int	No
timeSeries	form	TimeSeriesValue[]	No
resultId	form	int	No
error	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

**ReplyInfo** Parameters:
Name	Parameter	Data Type	Required
RcvTime	form	double	No
ReplyTime	form	double	No
ClientRequestHandle	form	string	No
Error	form	string	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/measurements/timeseries HTTP/1.1 
Host: mdn.bazefield.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	keys: 
	[
		String
	],
	from: String,
	to: String,
	numPoints: 0,
	includeBounds: False,
	metaData: String,
	clientRequestHandle: String,
	inObjectTime: False
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	timeSeriesList: 
	[
		{
			measurementId: 0,
			measurementName: String,
			unit: String,
			aggregateType: 0,
			timeSeries: 
			[
				{
					t: 0,
					q: 0,
					v: {},
					t_local: 0001-01-01T00:00:00.0000000+00:00
				}
			],
			resultId: 0,
			error: String
		}
	],
	startTime: 0,
	endTime: 0,
	replyInfo: 
	{
		rcvTime: 0,
		replyTime: 0,
		clientRequestHandle: String,
		error: String
	}
}