BazeField Services

GetAllocation

Allocations API

The following routes are available for this service:
GET	/allocations/{Id}

**GetAllocation** Parameters:
Name	Parameter	Data Type	Required	Description
Id	path	int	No

**Allocation** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
TurbineId	form	int	No
ObjectId	form	string	No
TurbineName	form	string	No
TurbineTitle	form	string	No
SourceId	form	int	No
SourceName	form	string	No
RootCause	form	string	No
TriggeredByAlarm	form	TriggerAlarm	No
Category	form	AllocationCategoryWithType	No
Categories	form	List<AllocationCategoryWithType>	No
Start	form	DateTime	No
End	form	DateTime	No
Start_Local	form	DateTimeOffset	No
End_Local	form	DateTimeOffset	No
Duration	form	TimeSpan	No
LastModified	form	DateTime	No
IsUnclassified	form	bool	No
ManualOverrideLoss	form	bool?	No
ResponseTime	form	DateTime?	No
LostProduction	form	double?	No
LostProdutionFiltered	form	double?	No
LostMoney	form	double?	No
LostMoneyFiltered	form	double?	No
Properties	form	List<AllocationPropertyValue>	No
Finished	form	bool	No
Manual	form	bool	No
Overridden	form	bool	No
Reallocated	form	bool	No
Pending	form	bool	No
ChangeLog	form	string	No
LastComment	form	Comment	No
Exported	form	string	No
Labels	form	List<Label>	No
Suspect	form	bool?	No
Uncertain	form	bool	No
EventId	form	int?	No
HasEvent	form	bool	No
HoldCategory	form	bool	No
Approved	form	bool	No
SfId	form	string	No
FirstAlarmSfId	form	string	No
RootCauseAlarmId	form	int?	No

**TriggerAlarm** Parameters:
Name	Parameter	Data Type	Required
Alarm	form	Alarm	No
Start	form	DateTime	No
End	form	DateTime?	No
LogId	form	int	No
SfId	form	string	No

**Alarm** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
Code	form	int	No
AlarmCode	form	AlarmCode	No
Name	form	string	No
BrakePrg	form	int	No
CanTriggerAllocation	form	bool	No
Description	form	string	No
Remarks	form	string	No
ResetPrg	form	Char	No
IsOkAlarm	form	bool	No
Meta	form	Dictionary<string, string>	No
AlarmType	form	byte	No
Type	form	string	No

**AlarmCode** Parameters:
Name	Parameter	Data Type	Required
EventNumber	form	int	No
Parameter1	form	int?	No
VendorEventType	form	string	No

**AllocationCategoryWithType** Parameters:
Name	Parameter	Data Type	Required	Description
AllocationType	form	AllocationType	No

**AllocationCategory** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
Name	form	string	No
Acronym	form	string	No
Color	form	string	No
Uncategorized	form	bool	No
Available	form	bool	No
TypeId	form	int	No
Group	form	string	No
SortIndex	form	byte	No
Priority	form	int	No
Enabled	form	bool	No
Performance	form	byte	No
Excluded	form	int	No
ParentCategoryId	form	int?	No
ParentCategoryName	form	string	No
Code	form	string	No
VariantAlias	form	string	No
Attributes	form	Dictionary<string, string>	No

**AllocationType** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
Name	form	string	No
Acronym	form	string	No
Version	form	string	No
Description	form	string	No
SortOrder	form	int	No
LinkedTypeId	form	int?	No
SubType	form	bool?	No
GroupName	form	string	No
DefaultVisible	form	bool	No
DomainId	form	int?	No
Disabled	form	bool	No
Matrix	form	string	No
Certified	form	bool?	No
AllocationTypeClassId	form	int	No
VariantOfAbstractTypeId	form	int?	No

**AllocationPropertyValue** Parameters:
Name	Parameter	Data Type	Required
Name	form	string	No
DisplayName	form	string	No
Value	form	double	No
LimitedValue	form	double?	No
Unit	form	string	No
IsOverride	form	bool	No
Description	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
Alarm	3
Case	4

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.

GET /allocations/{Id} HTTP/1.1 
Host: monitoring.ox2.com 
Accept: text/jsv

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

{
	id: 0,
	turbineId: 0,
	objectId: String,
	turbineName: String,
	turbineTitle: String,
	sourceId: 0,
	sourceName: String,
	rootCause: String,
	triggeredByAlarm: 
	{
		alarm: 
		{
			id: 0,
			code: 0,
			name: String,
			brakePrg: 0,
			canTriggerAllocation: False,
			description: String,
			remarks: String,
			resetPrg: ,
			isOkAlarm: False,
			meta: 
			{
				String: String
			},
			alarmType: 0,
			type: Warning
		},
		start: 0001-01-01,
		end: 0001-01-01,
		logId: 0,
		sfId: String
	},
	category: 
	{
		allocationType: 
		{
			id: 0,
			name: String,
			acronym: String,
			version: String,
			description: String,
			sortOrder: 0,
			linkedTypeId: 0,
			subType: False,
			groupName: String,
			defaultVisible: False,
			domainId: 0,
			disabled: False,
			matrix: String,
			certified: False,
			allocationTypeClassId: 0,
			variantOfAbstractTypeId: 0
		},
		id: 0,
		name: String,
		acronym: String,
		color: String,
		uncategorized: False,
		available: False,
		typeId: 0,
		group: String,
		sortIndex: 0,
		priority: 0,
		enabled: False,
		performance: 0,
		excluded: 0,
		parentCategoryId: 0,
		parentCategoryName: String,
		code: String,
		variantAlias: String,
		attributes: 
		{
			String: String
		}
	},
	categories: 
	[
		{
			allocationType: 
			{
				id: 0,
				name: String,
				acronym: String,
				version: String,
				description: String,
				sortOrder: 0,
				linkedTypeId: 0,
				subType: False,
				groupName: String,
				defaultVisible: False,
				domainId: 0,
				disabled: False,
				matrix: String,
				certified: False,
				allocationTypeClassId: 0,
				variantOfAbstractTypeId: 0
			},
			id: 0,
			name: String,
			acronym: String,
			color: String,
			uncategorized: False,
			available: False,
			typeId: 0,
			group: String,
			sortIndex: 0,
			priority: 0,
			enabled: False,
			performance: 0,
			excluded: 0,
			parentCategoryId: 0,
			parentCategoryName: String,
			code: String,
			variantAlias: String,
			attributes: 
			{
				String: String
			}
		}
	],
	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,
	duration: P739710DT15H27M35.0692215S,
	lastModified: 0001-01-01,
	isUnclassified: False,
	manualOverrideLoss: False,
	responseTime: 0001-01-01,
	lostProduction: 0,
	lostProdutionFiltered: 0,
	lostMoney: 0,
	lostMoneyFiltered: 0,
	properties: 
	[
		{
			
		}
	],
	finished: False,
	manual: False,
	overridden: False,
	reallocated: False,
	pending: False,
	changeLog: String,
	lastComment: 
	{
		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
	},
	exported: String,
	labels: 
	[
		{
			id: 0,
			name: String,
			color: String,
			type: 0
		}
	],
	suspect: False,
	uncertain: False,
	eventId: 0,
	hasEvent: False,
	holdCategory: False,
	approved: False,
	sfId: String,
	firstAlarmSfId: String,
	rootCauseAlarmId: 0
}