BazeField Services

<back to all web services

ReadMeasurementDefinition

Measurement API
Requires Authentication
The following routes are available for this service:
POST/api/measurements/definition/search
GET/api/measurements/{Keys}/definition
ReadMeasurementDefinition Parameters:
NameParameterData TypeRequiredDescription
Keyspathstring[]No
MaxResultsbodyint?No
ClientRequestHandlebodystringNo
ReadMeasurementDefinitionReplyList Parameters:
NameParameterData TypeRequiredDescription
definitionsformMeasurementDefinition[]No
replyInfoformReplyInfoNo
MeasurementDefinition Parameters:
NameParameterData TypeRequiredDescription
measurementIdformintNo
nameformstringNo
orignalNameformstringNo
attributesformstringNo
unitformstringNo
descriptionformstringNo
driverSourceformstringNo
tagStatusformstringNo
euFullScaleformdoubleNo
euZeroScaleformdoubleNo
parameterTypeIdformintNo
relatedMeasurementIdformintNo
systemAttributesformstringNo
errorformstringNo
ReplyInfo Parameters:
NameParameterData TypeRequiredDescription
RcvTimeformdoubleNo
ReplyTimeformdoubleNo
ClientRequestHandleformstringNo
ErrorformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

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: text/csv
Content-Type: text/csv
Content-Length: length

{"keys":["String"],"maxResults":0,"clientRequestHandle":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"definitions":[{"measurementId":0,"name":"String","orignalName":"String","attributes":"String","unit":"String","description":"String","driverSource":"String","tagStatus":"String","euFullScale":0,"euZeroScale":0,"parameterTypeId":0,"relatedMeasurementId":0,"systemAttributes":"String","error":"String"}],"replyInfo":{"rcvTime":0,"replyTime":0,"clientRequestHandle":"String","error":"String"}}