BazeField Services

ExportAlarmHistory

Alarm API

Returns the alarm history

The following routes are available for this service:
GET,POST	/api/objects/alarmhistory
GET	/api/objects/alarmhistory/export	Export as workbook

**ExportAlarmHistory** Parameters:
Name	Parameter	Data Type	Required	Description
ExportType	body	string	No

**GetAlarmHistory** Parameters:
Name	Parameter	Data Type	Required
TurbineIds	form	List<string>	No
ObjectIds	form	List<string>	No
SourceIds	form	List<string>	No
From	form	string	No
To	form	string	No
InObjectTime	form	bool?	No
Skip	form	int	No
Take	form	int?	No
OrderBy	form	string	No
Filter	form	string	No
Type	form	AlarmType?	No
IncludeOkAlarms	form	bool	No
FilterRootCauses	form	bool	No
FilterActive	form	bool	No
ClientRequestHandle	form	string	No

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

**AlarmLogReply** Parameters:
Name	Parameter	Data Type	Required
Alarms	form	List<AlarmLogEntry>	No
TotalItems	form	int	No
Page	form	long	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

**AlarmLogEntry** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
AlarmId	form	int	No
SiteId	form	int	No
SiteName	form	string	No
TurbineId	form	int	No
ObjectId	form	string	No
TurbineName	form	string	No
TurbineTitle	form	string	No
EventType	form	string	No
Start	form	DateTime	No
UncertainStopTime	form	DateTime?	No
StopTime	form	DateTime?	No
AckTime	form	DateTime?	No
Start_Local	form	DateTimeOffset?	No
UncertainStopTime_Local	form	DateTimeOffset?	No
StopTime_Local	form	DateTimeOffset?	No
AckTime_Local	form	DateTimeOffset?	No
Alarm	form	string	No
AlarmDescription	form	string	No
Code	form	int	No
Parameter1	form	int?	No
AllocationId	form	int?	No
BrakePrg	form	byte	No
Priority	form	int?	No
EventState	form	int?	No
IsOkAlarm	form	bool	No
AlarmType	form	int	No
SourceId	form	int	No
SourceName	form	string	No
Comments	form	List<Comment>	No
IsRootCause	form	bool	No
AlarmRemarks	form	string	No
Allocations	form	List<AlarmAllocation>	No
End	form	DateTime?	No
End_Local	form	DateTimeOffset?	No
Duration	form	TimeSpan	No
AckDuration	form	TimeSpan	No
Type	form	string	No

**Comment** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
TurbineId	form	int	No
TurbineName	form	string	No
TimeStamp	form	DateTime	No
Text	form	string	No
CreatedBy	form	string	No
CreatedById	form	decimal?	No
LastModified	form	DateTime	No
Type	form	CommentType	No
External	form	bool?	No
Sticky	form	bool?	No
AllocationId	form	int?	No
AlarmLogId	form	int?	No
AlarmId	form	int?	No
CommandId	form	int?	No
RelatedInfo	form	string	No
Cleared	form	bool	No
Labels	form	List<Label>	No
ObjectId	form	string	No
RelatedStart	form	DateTime?	No
RelatedEnd	form	DateTime?	No

**CommentType** Enum:
Turbine
Allocation
Alarm

**Label** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
Name	form	string	No
Color	form	string	No
Type	form	LabelType?	No

**LabelType** Enum:
Name	Value
Allocation	1
Other	2

**AlarmAllocation** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
CategoryId	form	int?	No
CategoryName	form	string	No
CategoryColor	form	string	No
TypeId	form	int	No
SubType	form	bool	No
AllocationId	form	int	No
Start	form	DateTime	No
End	form	DateTime?	No
Start_Local	form	DateTimeOffset?	No
End_Local	form	DateTimeOffset?	No
TypeName	form	string	No
LostProduction	form	double?	No
Duration	form	TimeSpan	No
Acronym	form	string	No
Available	form	bool	No
Excluded	form	int	No
Performance	form	byte	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/objects/alarmhistory HTTP/1.1 
Host: mdn.bazefield.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	exportType: String,
	turbineIds: 
	[
		String
	],
	objectIds: 
	[
		String
	],
	sourceIds: 
	[
		String
	],
	from: String,
	to: String,
	inObjectTime: False,
	skip: 0,
	take: 0,
	orderBy: String,
	filter: String,
	type: Warning,
	includeOkAlarms: False,
	filterRootCauses: False,
	filterActive: False,
	clientRequestHandle: String
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	alarms: 
	[
		{
			id: 0,
			alarmId: 0,
			siteId: 0,
			siteName: String,
			turbineId: 0,
			objectId: String,
			turbineName: String,
			turbineTitle: String,
			eventType: String,
			start: 0001-01-01,
			uncertainStopTime: 0001-01-01,
			stopTime: 0001-01-01,
			ackTime: 0001-01-01,
			start_Local: 0001-01-01T00:00:00.0000000+00:00,
			uncertainStopTime_Local: 0001-01-01T00:00:00.0000000+00:00,
			stopTime_Local: 0001-01-01T00:00:00.0000000+00:00,
			ackTime_Local: 0001-01-01T00:00:00.0000000+00:00,
			alarm: String,
			alarmDescription: String,
			code: 0,
			parameter1: 0,
			allocationId: 0,
			brakePrg: 0,
			priority: 0,
			eventState: 0,
			isOkAlarm: False,
			alarmType: 0,
			sourceId: 0,
			sourceName: String,
			comments: 
			[
				{
					id: 0,
					turbineId: 0,
					turbineName: String,
					timeStamp: 0001-01-01,
					text: String,
					createdBy: String,
					createdById: 0,
					lastModified: 0001-01-01,
					type: Turbine,
					external: False,
					sticky: False,
					allocationId: 0,
					alarmLogId: 0,
					alarmId: 0,
					commandId: 0,
					relatedInfo: String,
					cleared: False,
					labels: 
					[
						{
							id: 0,
							name: String,
							color: String,
							type: 0
						}
					],
					objectId: String,
					relatedStart: 0001-01-01,
					relatedEnd: 0001-01-01
				}
			],
			isRootCause: False,
			alarmRemarks: String,
			allocations: 
			[
				{
					id: 0,
					categoryId: 0,
					categoryName: String,
					categoryColor: String,
					typeId: 0,
					subType: False,
					allocationId: 0,
					start: 0001-01-01,
					end: 0001-01-01,
					start_Local: 0001-01-01T00:00:00.0000000+00:00,
					end_Local: 0001-01-01T00:00:00.0000000+00:00,
					typeName: String,
					lostProduction: 0,
					duration: PT0S,
					acronym: String,
					available: False,
					excluded: 0,
					performance: 0
				}
			],
			end: 0001-01-01,
			end_Local: 0001-01-01T00:00:00.0000000+00:00,
			duration: PT0S,
			ackDuration: PT0S,
			type: Warning
		}
	],
	totalItems: 0,
	page: 0,
	replyInfo: 
	{
		rcvTime: 0,
		replyTime: 0,
		clientRequestHandle: String,
		error: String
	}
}