BazeField Services

ReadMeasurementDefinition

Measurement API

The following routes are available for this service:
POST	/api/measurements/definition/search
GET	/api/measurements/{Keys}/definition

**ReadMeasurementDefinition** Parameters:
Name	Parameter	Data Type	Required
Keys	path	string[]	No
MaxResults	body	int?	No
ClientRequestHandle	body	string	No

**ReadMeasurementDefinitionReplyList** Parameters:
Name	Parameter	Data Type	Required	Description
definitions	form	MeasurementDefinition[]	No
replyInfo	form	ReplyInfo	No

**MeasurementDefinition** Parameters:
Name	Parameter	Data Type	Required
measurementId	form	int	No
name	form	string	No
orignalName	form	string	No
attributes	form	string	No
unit	form	string	No
description	form	string	No
driverSource	form	string	No
tagStatus	form	string	No
euFullScale	form	double	No
euZeroScale	form	double	No
parameterTypeId	form	int	No
relatedMeasurementId	form	int	No
systemAttributes	form	string	No
error	form	string	No

**ReplyInfo** Parameters:
Name	Parameter	Data Type	Required
RcvTime	form	double	No
ReplyTime	form	double	No
ClientRequestHandle	form	string	No
Error	form	string	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/measurements/definition/search HTTP/1.1 
Host: mdn.bazefield.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<ReadMeasurementDefinition xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BazeField.Measurements.WebService">
  <ClientRequestHandle>String</ClientRequestHandle>
  <Keys xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Keys>
  <MaxResults>0</MaxResults>
</ReadMeasurementDefinition>

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

<ReadMeasurementDefinitionReplyList xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BazeField.Historian.DataServices">
  <definitions>
    <MeasurementDefinition>
      <attributes>String</attributes>
      <description>String</description>
      <driverSource>String</driverSource>
      <error>String</error>
      <euFullScale>0</euFullScale>
      <euZeroScale>0</euZeroScale>
      <measurementId>0</measurementId>
      <name>String</name>
      <orignalName>String</orignalName>
      <parameterTypeId>0</parameterTypeId>
      <relatedMeasurementId>0</relatedMeasurementId>
      <systemAttributes>String</systemAttributes>
      <tagStatus>String</tagStatus>
      <unit>String</unit>
    </MeasurementDefinition>
  </definitions>
  <replyInfo xmlns:d2p1="http://schemas.datacontract.org/2004/07/Bazefield.WebService.Common">
    <d2p1:ClientRequestHandle>String</d2p1:ClientRequestHandle>
    <d2p1:Error>String</d2p1:Error>
    <d2p1:RcvTime>0</d2p1:RcvTime>
    <d2p1:ReplyTime>0</d2p1:ReplyTime>
  </replyInfo>
</ReadMeasurementDefinitionReplyList>