BazeField Services

<back to all web services

GetAlarmStatisticsChart

Alarm API
Requires Authentication
The following routes are available for this service:
GET/api/turbines/alarmlog/statisticsChart/from/{From}/to/{To}Obsolete
GET,POST/api/turbines/alarmlog/statistics/from/{From}/to/{To}Obsolete
GET/api/turbines/{TurbineIds}/alarmlog/statisticsChart/from/{From}/to/{To}Obsolete
GET,POST/api/turbines/{TurbineIds}/alarmlog/statistics/from/{From}/to/{To}Obsolete
GET,POST/api/objects/alarmlog/statistics
GET/api/turbines/alarmlog/statisticsChart
GetAlarmStatisticsChart Parameters:
NameParameterData TypeRequiredDescription
ChartTypebodystringNo
ChartBybodystringNo
Heightbodyint?No
Widthbodyint?No
LegendTypebodyAlarmLegendType?No
GetAlarmStatistics Parameters:
NameParameterData TypeRequiredDescription
TurbineIdsformList<string>NoAssets contributing to total count and total duration. Will also define the return values in the case when TurbineToDrillInto is not specified
TurbineToDrillIntoformstringNoOptional. Specify additionally to parameter TurbineIds when drilling into the alarm codes for one specific asset.
FromformstringNo
ToformstringNo
TypeformAlarmType?No
OrderByformstringNo
Takeformint?No
IncludeOkAlarmsformboolNo
ChartGroupformstringNo
AlarmIdformint?No
SourceIdsformList<int>No
AlarmCodeformint?No
AllocationTypeIdformint?No
Parameter1formint?No
VendorEventTypeformstringNo
AlarmDescriptionformstringNo
AlarmType Enum:
NameValue
Warning0
Alarm1
Status2
Auto4
ConfigPending8
AlarmLegendType Enum:
Code
Description
CodeDescription
AlarmStatsReplyList Parameters:
NameParameterData TypeRequiredDescription
AlarmStatsformList<AlarmStats>No
TotalDurationformdoubleNo
TotalCountformdoubleNo
MTTRformdoubleNo
MTBFformdoubleNo
MostFrequentformAlarmStatsNo
LongestDurationformAlarmStatsNo
TotalLostProductionformdoubleNo
TotalLostMoneyformdoubleNo
AlarmStats Parameters:
NameParameterData TypeRequiredDescription
CodeformintNo
AlarmTypeformintNo
AlarmIdformintNo
AlarmDescriptionformstringNo
DurationformdoubleNo
DurationPercentageformdoubleNo
CountformintNo
TurbinesformintNo
FrequencyformdoubleNo
ErrorRatePercentageformdoubleNo
MTBFformdoubleNo
MTTRformdoubleNo
SourceIdformintNo
LostProductionformdouble?No
LostMoneyformdouble?No
Parameter1formstringNo
VendorEventTypeformstringNo
StatItemIdformintNo
StatItemNameformstringNo
TypeformstringNo

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /api/turbines/alarmlog/statistics/from/{From}/to/{To} HTTP/1.1 
Host: mdn.bazefield.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"chartType":"String","chartBy":"String","height":0,"width":0,"legendType":"Code","turbineIds":["String"],"turbineToDrillInto":"String","from":"String","to":"String","type":"Warning","orderBy":"String","take":0,"includeOkAlarms":false,"chartGroup":"String","alarmId":0,"sourceIds":[0],"alarmCode":0,"allocationTypeId":0,"parameter1":0,"vendorEventType":"String","alarmDescription":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"alarmStats":[{"code":0,"alarmType":0,"alarmId":0,"alarmDescription":"String","duration":0,"durationPercentage":0,"count":0,"turbines":0,"frequency":0,"errorRatePercentage":0,"mtbf":0,"mttr":0,"sourceId":0,"lostProduction":0,"lostMoney":0,"parameter1":"String","vendorEventType":"String","statItemId":0,"statItemName":"String","type":"Warning"}],"totalDuration":0,"totalCount":0,"mttr":0,"mtbf":0,"mostFrequent":{"code":0,"alarmType":0,"alarmId":0,"alarmDescription":"String","duration":0,"durationPercentage":0,"count":0,"turbines":0,"frequency":0,"errorRatePercentage":0,"mtbf":0,"mttr":0,"sourceId":0,"lostProduction":0,"lostMoney":0,"parameter1":"String","vendorEventType":"String","statItemId":0,"statItemName":"String","type":"Warning"},"longestDuration":{"code":0,"alarmType":0,"alarmId":0,"alarmDescription":"String","duration":0,"durationPercentage":0,"count":0,"turbines":0,"frequency":0,"errorRatePercentage":0,"mtbf":0,"mttr":0,"sourceId":0,"lostProduction":0,"lostMoney":0,"parameter1":"String","vendorEventType":"String","statItemId":0,"statItemName":"String","type":"Warning"},"totalLostProduction":0,"totalLostMoney":0}