BazeField Services

GetDomainPointTimeSeriesAggregated

Domain Data API

The following routes are available for this service:
GET, POST	/api/objects/timeseries/aggregated	Gets aggregated timeseries data for objects

**GetDomainPointTimeSeriesAggregated** Parameters:
Name	Parameter	Data Type	Required	Description
ObjectIds	body	List<string>	No
Points	body	List<string>	No
Aggregates	body	List<string>	Yes	Legal aggration type, e.g. AVERAGE, TIMEAVERAGE, START, END, etc.
Fields	body	List<string>	No
From	body	string	Yes	Javascript time, shorthand notation like * (now), d (start of today), d-1d (start of yesterday), etc. or ISO time
To	body	string	Yes	Javascript time, shorthand notation like * (now), d (start of today), d-1d (start of yesterday), etc. or ISO time
Interval	body	string	No
ExpectHdaCompatible	body	bool?	No
InObjectTime	body	bool?	No
DataFilter	body	string	No
Conditions	body	string	No
QueryOptions	body	string	No
ClientRequestHandle	body	string	No

**DomainPointTimeSeriesGetResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Objects	form	Dictionary<string, DomainPointTimeSeries>	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

**DomainPointTimeSeries** Parameters:
Name	Parameter	Data Type	Required	Description
Points	form	Dictionary<string, List<ObjectPointTimeSeries>>	No

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 HTTP/1.1 
Host: mdn.bazefield.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GetDomainPointTimeSeriesAggregated 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>
</GetDomainPointTimeSeriesAggregated>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<DomainPointTimeSeriesGetResponse 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:KeyValueOfstringDomainPointTimeSeriesdG1LNjhA>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value xmlns:d4p1="http://schemas.datacontract.org/2004/07/Bazefield.Domain.Data.Entity">
        <d4p1:Points>
          <d2p1:KeyValueOfstringArrayOfObjectPointTimeSeriesdG1LNjhA>
            <d2p1:Key>String</d2p1:Key>
            <d2p1:Value>
              <d4p1:ObjectPointTimeSeries>
                <d4p1:Aggregate>String</d4p1:Aggregate>
                <d4p1:Attributes>
                  <d2p1:KeyValueOfstringstring>
                    <d2p1:Key>String</d2p1:Key>
                    <d2p1:Value>String</d2p1:Value>
                  </d2p1:KeyValueOfstringstring>
                </d4p1:Attributes>
                <d4p1:Error>String</d4p1:Error>
                <d4p1:From>0001-01-01T00:00:00</d4p1:From>
                <d4p1:Interval>String</d4p1:Interval>
                <d4p1:IsHdaCompatible>false</d4p1:IsHdaCompatible>
                <d4p1:ObjectId>String</d4p1:ObjectId>
                <d4p1:PointName>String</d4p1:PointName>
                <d4p1:ResultId>0</d4p1:ResultId>
                <d4p1:TimeSeries>
                  <d4p1:TimeSeriesValueLocal>
                    <q xmlns="http://schemas.datacontract.org/2004/07/BazeField.Historian.DataServices">0</q>
                    <t xmlns="http://schemas.datacontract.org/2004/07/BazeField.Historian.DataServices">0</t>
                    <t_local xmlns:d11p1="http://schemas.datacontract.org/2004/07/System" xmlns="http://schemas.datacontract.org/2004/07/BazeField.Historian.DataServices">
                      <d11p1:DateTime>0001-01-01T00:00:00Z</d11p1:DateTime>
                      <d11p1:OffsetMinutes>0</d11p1:OffsetMinutes>
                    </t_local>
                    <v xmlns="http://schemas.datacontract.org/2004/07/BazeField.Historian.DataServices" />
                  </d4p1:TimeSeriesValueLocal>
                </d4p1:TimeSeries>
                <d4p1:To>0001-01-01T00:00:00</d4p1:To>
              </d4p1:ObjectPointTimeSeries>
            </d2p1:Value>
          </d2p1:KeyValueOfstringArrayOfObjectPointTimeSeriesdG1LNjhA>
        </d4p1:Points>
      </d2p1:Value>
    </d2p1:KeyValueOfstringDomainPointTimeSeriesdG1LNjhA>
  </Objects>
</DomainPointTimeSeriesGetResponse>