BazeField Services

GetAlarmStatistics

Alarm API

The following routes are available for this service:
GET,POST	/api/turbines/alarmlog/statistics/from/{From}/to/{To}	Obsolete
GET,POST	/api/turbines/{TurbineIds}/alarmlog/statistics/from/{From}/to/{To}	Obsolete
GET,POST	/api/objects/alarmlog/statistics

**GetAlarmStatistics** Parameters:
Name	Parameter	Data Type	Required	Description
TurbineIds	path	List<string>	No	Assets contributing to total count and total duration. Will also define the return values in the case when TurbineToDrillInto is not specified
TurbineToDrillInto	body	string	No	Optional. Specify additionally to parameter TurbineIds when drilling into the alarm codes for one specific asset.
From	path	string	No
To	path	string	No
Type	body	AlarmType?	No
OrderBy	body	string	No
Take	body	int?	No
IncludeOkAlarms	body	bool	No
ChartGroup	body	string	No
AlarmId	body	int?	No
SourceIds	body	List<int>	No
AlarmCode	body	int?	No
AllocationTypeId	body	int?	No
Parameter1	body	int?	No
VendorEventType	body	string	No
AlarmDescription	body	string	No

**AlarmType** Enum:
Name	Value
Warning	0
Alarm	1
Status	2
Auto	4
ConfigPending	8

**AlarmStatsReplyList** Parameters:
Name	Parameter	Data Type	Required
AlarmStats	form	List<AlarmStats>	No
TotalDuration	form	double	No
TotalCount	form	double	No
MTTR	form	double	No
MTBF	form	double	No
MostFrequent	form	AlarmStats	No
LongestDuration	form	AlarmStats	No
TotalLostProduction	form	double	No
TotalLostMoney	form	double	No

**AlarmStats** Parameters:
Name	Parameter	Data Type	Required
Code	form	int	No
AlarmType	form	int	No
AlarmId	form	int	No
AlarmDescription	form	string	No
Duration	form	double	No
DurationPercentage	form	double	No
Count	form	int	No
Turbines	form	int	No
Frequency	form	double	No
ErrorRatePercentage	form	double	No
MTBF	form	double	No
MTTR	form	double	No
SourceId	form	int	No
LostProduction	form	double?	No
LostMoney	form	double?	No
Parameter1	form	string	No
VendorEventType	form	string	No
StatItemId	form	int	No
StatItemName	form	string	No
Type	form	string	No

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

HTTP + JSV

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

{
	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: text/jsv
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
}