BazeField Services

<back to all web services

GetDomainPointTimeSeries

Domain Data API
Requires Authentication
The following routes are available for this service:
GET, POST/api/objects/timeseriesGets raw timeseries data for objects
GetDomainPointTimeSeries Parameters:
NameParameterData TypeRequiredDescription
ObjectIdsbodyList<string>No
PointsbodyList<string>No
FieldsbodyList<string>No
FrombodystringNo
TobodystringNo
ExpectHdaCompatiblebodybool?No
InObjectTimebodybool?No
BoundsbodyboolNo
Takebodyint?No
DescendingbodyboolNo
DataFilterbodystringNo
QueryOptionsbodystringNo
ClientRequestHandlebodystringNo
DomainPointTimeSeriesGetResponse Parameters:
NameParameterData TypeRequiredDescription
ObjectsformDictionary<string, DomainPointTimeSeries>No
BazefieldResponse Parameters:
NameParameterData TypeRequiredDescription
ReplyInfoformReplyInfoNo
ReplyInfo Parameters:
NameParameterData TypeRequiredDescription
RcvTimeformdoubleNo
ReplyTimeformdoubleNo
ClientRequestHandleformstringNo
ErrorformstringNo
DomainPointTimeSeries Parameters:
NameParameterData TypeRequiredDescription
PointsformDictionary<string, List<ObjectPointTimeSeries>>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/timeseries HTTP/1.1 
Host: mdn.bazefield.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	objectIds: 
	[
		String
	],
	points: 
	[
		String
	],
	fields: 
	[
		String
	],
	from: String,
	to: String,
	expectHdaCompatible: False,
	inObjectTime: False,
	bounds: False,
	take: 0,
	descending: False,
	dataFilter: String,
	queryOptions: String,
	clientRequestHandle: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	objects: 
	{
		String: 
		{
			points: 
			{
				String: 
				[
					{
						objectId: String,
						pointName: String,
						aggregate: String,
						timeSeries: 
						[
							{
								t: 0,
								q: 0,
								v: {},
								t_local: 0001-01-01T00:00:00.0000000+00:00
							}
						],
						from: 0001-01-01,
						to: 0001-01-01,
						interval: String,
						attributes: 
						{
							String: String
						},
						resultId: 0,
						error: String,
						isHdaCompatible: False
					}
				]
			}
		}
	},
	replyInfo: 
	{
		rcvTime: 0,
		replyTime: 0,
		clientRequestHandle: String,
		error: String
	}
}