BazeField Services

ActiveAllocationsGetRequest

Allocations API

The following routes are available for this service:
GET, POST	/api/objects/allocations/active	Gets active allocations for objects.

**ActiveAllocationsGetRequest** Parameters:
Name	Parameter	Data Type	Required
ObjectIds	body	List<string>	No
AllocationTypes	body	List<string>	No
Categories	body	List<string>	No

**ActiveAllocationsGetResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Result	form	Dictionary<string, ObjectAllocations>	No

**ObjectAllocations** Parameters:
Name	Parameter	Data Type	Required	Description
Allocations	form	List<ObjectAllocation>	No

**ObjectAllocation** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
TurbineId	form	int	No
ObjectId	form	long?	No
SourceId	form	int?	No
TriggeredByAlarm	form	ObjectAlarmLogEntry	No
Category	form	AllocationCategory	No
Categories	form	Dictionary<string, AllocationCategory>	No
Start	form	DateTime	No
End	form	DateTime?	No
LastModified	form	DateTime	No
ResponseTime	form	DateTime?	No
LostProduction	form	double?	No
LostMoney	form	double?	No
Finished	form	bool	No
Manual	form	bool	No
Overridden	form	bool	No
Reallocated	form	bool	No
Uncertain	form	bool	No
Suspect	form	bool?	No
Trigger	form	string	No

**ObjectAlarmLogEntry** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
TurbineId	form	int?	No
ItemId	form	int?	No
StartTime	form	DateTime	No
StopTime	form	DateTime?	No
AckTime	form	DateTime?	No
UncertainStopTime	form	DateTime?	No
Guid	form	Guid	No
Realarm	form	bool	No
SourceId	form	int?	No
AlarmCode	form	AlarmCode	No
AlarmType	form	AlarmType	No
Alarm	form	Alarm	No
ModifiedDate	form	DateTime	No
VendorLogId	form	int?	No
ObjectId	form	long?	No
AlarmDescription	form	string	No

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

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

**Alarm** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
Type	form	AlarmType	No
Code	form	AlarmCode	No
VendorAlarmId	form	int?	No
Name	form	string	No
BrakePrg	form	int	No
Description	form	string	No
IsOkAlarm	form	bool	No
IsAvailableOnAck	form	bool?	No
ClearByOKAlarm	form	bool	No
CanTriggerAllocation	form	bool	No
StatusIndicator	form	string	No
Remarks	form	string	No

**AllocationCategory** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
Name	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
Attributes	form	Dictionary<string, string>	No
AllocationType	form	AllocationType	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
FactoryDefaultUrl	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

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/allocations/active HTTP/1.1 
Host: mdn.bazefield.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	objectIds: 
	[
		String
	],
	allocationTypes: 
	[
		String
	],
	categories: 
	[
		String
	]
}

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

{
	result: 
	{
		String: 
		{
			allocations: 
			[
				{
					id: 0,
					turbineId: 0,
					objectId: 0,
					sourceId: 0,
					triggeredByAlarm: 
					{
						id: 0,
						turbineId: 0,
						itemId: 0,
						startTime: 0001-01-01,
						stopTime: 0001-01-01,
						ackTime: 0001-01-01,
						uncertainStopTime: 0001-01-01,
						realarm: False,
						sourceId: 0,
						alarmType: Warning,
						alarm: 
						{
							id: 0,
							type: Warning,
							vendorAlarmId: 0,
							name: String,
							brakePrg: 0,
							description: String,
							isOkAlarm: False,
							isAvailableOnAck: False,
							clearByOKAlarm: False,
							canTriggerAllocation: False,
							statusIndicator: String,
							remarks: String
						},
						modifiedDate: 0001-01-01,
						vendorLogId: 0,
						objectId: 0,
						alarmDescription: String
					},
					category: 
					{
						id: 0,
						name: 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,
						attributes: 
						{
							String: String
						},
						allocationType: 
						{
							id: 0,
							name: String,
							acronym: String,
							version: String,
							description: String,
							factoryDefaultUrl: String,
							sortOrder: 0,
							linkedTypeId: 0,
							subType: False,
							groupName: String,
							defaultVisible: False,
							domainId: 0,
							disabled: False
						}
					},
					categories: 
					{
						String: 
						{
							id: 0,
							name: 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,
							attributes: 
							{
								String: String
							},
							allocationType: 
							{
								id: 0,
								name: String,
								acronym: String,
								version: String,
								description: String,
								factoryDefaultUrl: String,
								sortOrder: 0,
								linkedTypeId: 0,
								subType: False,
								groupName: String,
								defaultVisible: False,
								domainId: 0,
								disabled: False
							}
						}
					},
					start: 0001-01-01,
					end: 0001-01-01,
					lastModified: 0001-01-01,
					responseTime: 0001-01-01,
					lostProduction: 0,
					lostMoney: 0,
					finished: False,
					manual: False,
					overridden: False,
					reallocated: False,
					uncertain: False,
					suspect: False,
					trigger: String
				}
			]
		}
	}
}