BazeField Services

DomainPointsGetRequest

Domain Data API

The following routes are available for this service:
GET, POST	/api/objects/points	Gets data for objects.
GET, POST	/api/objects/{ObjectIds}/points/{points}	Obsolete (will be removed in next major release.)

**DomainPointsGetRequest** Parameters:
Name	Parameter	Data Type	Required	Description
ObjectIds	path	List<string>	Yes	List of object ids
Points	path	List<string>	Yes	List of points, e.g. ActivePower
Fields	body	List<string>	No	Specify attributes to be included in the response
ClientRequestHandle	body	string	No
mdmids	body	List<string>	No

**DomainPointsGetResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Result	form	Dictionary<string, DomainPointValues>	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

**DomainPointValues** Parameters:
Name	Parameter	Data Type	Required	Description
Points	form	Dictionary<string, ObjectPointValueLocal>	No

**ObjectPointValueLocal** Parameters:
Name	Parameter	Data Type	Required	Description
Attributes	form	Dictionary<string, string>	No

**ObjectPointValue** Parameters:
Name	Parameter	Data Type	Required	Description
PointName	form	string	No
ObjectId	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

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

<DomainPointsGetRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Bazefield.Domain.Data.WebService.Request">
  <ClientRequestHandle>String</ClientRequestHandle>
  <Fields xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Fields>
  <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>
  <mdmids xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </mdmids>
</DomainPointsGetRequest>

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

<DomainPointsGetResponse 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>
  <Result xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringDomainPointValuesdG1LNjhA>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value xmlns:d4p1="http://schemas.datacontract.org/2004/07/Bazefield.Domain.Data.Entity">
        <d4p1:Points>
          <d2p1:KeyValueOfstringObjectPointValueLocaldG1LNjhA>
            <d2p1:Key>String</d2p1:Key>
            <d2p1:Value>
              <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:d8p1="http://schemas.datacontract.org/2004/07/System" xmlns="http://schemas.datacontract.org/2004/07/BazeField.Historian.DataServices">
                <d8p1:DateTime>0001-01-01T00:00:00Z</d8p1:DateTime>
                <d8p1:OffsetMinutes>0</d8p1:OffsetMinutes>
              </t_local>
              <v xmlns="http://schemas.datacontract.org/2004/07/BazeField.Historian.DataServices" />
              <d4p1:ObjectId>String</d4p1:ObjectId>
              <d4p1:PointName>String</d4p1:PointName>
              <d4p1:Attributes>
                <d2p1:KeyValueOfstringstring>
                  <d2p1:Key>String</d2p1:Key>
                  <d2p1:Value>String</d2p1:Value>
                </d2p1:KeyValueOfstringstring>
              </d4p1:Attributes>
            </d2p1:Value>
          </d2p1:KeyValueOfstringObjectPointValueLocaldG1LNjhA>
        </d4p1:Points>
      </d2p1:Value>
    </d2p1:KeyValueOfstringDomainPointValuesdG1LNjhA>
  </Result>
</DomainPointsGetResponse>