BazeField Services

<back to all web services

GetDomainPointAggregatedDataTable

Domain Data API
Requires Authentication
The following routes are available for this service:
GET, POST/api/objects/timeseries/aggregated/tableGet timeseries with response structured as table (timestamp on one axis).
GetDomainPointAggregatedDataTable Parameters:
NameParameterData TypeRequiredDescription
ObjectIdsbodyList<string>No
PointsbodyList<string>No
AggregatesbodyList<string>No
FieldsbodyList<string>No
FrombodystringNo
TobodystringNo
IntervalbodystringNo
ExpectHdaCompatiblebodybool?No
InObjectTimebodybool?No
DataFilterbodystringNo
ConditionsbodystringNo
QueryOptionsbodystringNo
ClientRequestHandlebodystringNo
DomainPointDataTableGetResponse Parameters:
NameParameterData TypeRequiredDescription
ObjectsformDictionary<string, DomainDataTable>No
BazefieldResponse Parameters:
NameParameterData TypeRequiredDescription
ReplyInfoformReplyInfoNo
ReplyInfo Parameters:
NameParameterData TypeRequiredDescription
RcvTimeformdoubleNo
ReplyTimeformdoubleNo
ClientRequestHandleformstringNo
ErrorformstringNo
DomainDataTable Parameters:
NameParameterData TypeRequiredDescription
RowsformList<ObjectDataRow>No
ObjectDataRow Parameters:
NameParameterData TypeRequiredDescription
ObjectIdformstringNo
TimeStampUtcformDateTimeNo
TimeStampLocalformDateTimeOffsetNo
PointValuesformDictionary<string, DataValue>No
DataValue Parameters:
NameParameterData TypeRequiredDescription
qformint?No
vformObjectNo

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/aggregated/table HTTP/1.1 
Host: mdn.bazefield.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

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

{
	objects: 
	{
		String: 
		{
			rows: 
			[
				{
					objectId: String,
					timeStampUtc: 0001-01-01,
					timeStampLocal: 0001-01-01T00:00:00.0000000+00:00,
					pointValues: 
					{
						String: 
						{
							q: 0,
							v: {}
						}
					}
				}
			]
		}
	},
	replyInfo: 
	{
		rcvTime: 0,
		replyTime: 0,
		clientRequestHandle: String,
		error: String
	}
}