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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<GetDomainPointAggregatedDataTable xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Bazefield.Domain.Data.WebService.Request">
  <Aggregates xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Aggregates>
  <ClientRequestHandle>String</ClientRequestHandle>
  <Conditions>String</Conditions>
  <DataFilter>String</DataFilter>
  <ExpectHdaCompatible>false</ExpectHdaCompatible>
  <Fields xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Fields>
  <From>String</From>
  <InObjectTime>false</InObjectTime>
  <Interval>String</Interval>
  <ObjectIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </ObjectIds>
  <Points xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Points>
  <QueryOptions>String</QueryOptions>
  <To>String</To>
</GetDomainPointAggregatedDataTable>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<DomainPointDataTableGetResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Bazefield.Domain.Data.WebService.Response">
  <ReplyInfo xmlns="http://schemas.datacontract.org/2004/07/Bazefield.WebService.Common">
    <ClientRequestHandle>String</ClientRequestHandle>
    <Error>String</Error>
    <RcvTime>0</RcvTime>
    <ReplyTime>0</ReplyTime>
  </ReplyInfo>
  <Objects xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringDomainDataTabledG1LNjhA>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value xmlns:d4p1="http://schemas.datacontract.org/2004/07/Bazefield.Domain.Data.Entity">
        <d4p1:Rows>
          <d4p1:ObjectDataRow>
            <d4p1:ObjectId>String</d4p1:ObjectId>
            <d4p1:PointValues>
              <d2p1:KeyValueOfstringDataValuedG1LNjhA>
                <d2p1:Key>String</d2p1:Key>
                <d2p1:Value>
                  <d4p1:q>0</d4p1:q>
                  <d4p1:v />
                </d2p1:Value>
              </d2p1:KeyValueOfstringDataValuedG1LNjhA>
            </d4p1:PointValues>
            <d4p1:TimeStampLocal xmlns:d7p1="http://schemas.datacontract.org/2004/07/System">
              <d7p1:DateTime>0001-01-01T00:00:00Z</d7p1:DateTime>
              <d7p1:OffsetMinutes>0</d7p1:OffsetMinutes>
            </d4p1:TimeStampLocal>
            <d4p1:TimeStampUtc>0001-01-01T00:00:00</d4p1:TimeStampUtc>
          </d4p1:ObjectDataRow>
        </d4p1:Rows>
      </d2p1:Value>
    </d2p1:KeyValueOfstringDomainDataTabledG1LNjhA>
  </Objects>
</DomainPointDataTableGetResponse>