BazeField Services

GetAllocationStatisticsChart

Allocations API

The following routes are available for this service:
GET	/api/turbines/{TurbineIds}/allocations/{Type}/statisticsChart/from/{From}/to/{To}
GET	/api/turbines/{TurbineIds}/allocations/{Type}/statistics/from/{From}/to/{To}
GET	/api/turbines/allocations/{Type}/statisticsChart/from/{From}/to/{To}
GET,POST	/api/turbines/allocations/{Type}/statistics/from/{From}/to/{To}
GET	/api/turbines/allocations/statisticsChart
GET,POST	/api/turbines/allocations/statistics

**GetAllocationStatisticsChart** Parameters:
Name	Parameter	Data Type	Required
ChartType	body	string	No
ChartBy	body	string	No
Height	body	int?	No
Width	body	int?	No

**FindTurbineAllocationStatistics** Parameters:
Name	Parameter	Data Type	Required
TurbineIds	form	List<string>	No
SourceIds	form	List<string>	No
CategoryIds	form	List<string>	No
Type	form	string	No
From	form	string	No
To	form	string	No
OrderBy	form	string	No
ThenBy	form	string	No
AllocationCategoriesFilter	form	List<string>	No
Take	form	int?	No
ChartGroup	form	string	No
IncludeAvailable	form	bool	No
IncludeExcluded	form	bool	No
InObjectTime	form	bool?	No
CompatibilityMode	form	bool?	No
CompatibilityModeForDrillDown	form	bool?	No

**AllocationStatsReplyList** Parameters:
Name	Parameter	Data Type	Required
TotalAvailability	form	double	No
ProductionAvailability	form	double?	No
HasDeratedCategories	form	bool	No
TotalLostMoney	form	double	No
TotalLostProduction	form	double	No
TotalUnavailableLostMoney	form	double	No
TotalUnavailableProduction	form	double	No
TotalActualProduction	form	double	No
TurnoverProduction	form	double	No
TotalDuration	form	double	No
TotalCount	form	double	No
ReportedDuration	form	double	No
AllocationStatsLostMoney	form	double	No
AllocationStatsLostProduction	form	double	No
AllocationStatsDuration	form	double	No
AllocationStatsTotalCount	form	double	No
TotalAssetCount	form	int	No
AllocationStats	form	List<AllocationStats>	No
MTTR	form	double	No
MTBF	form	double	No
MostFrequent	form	AllocationStats	No
LongestDuration	form	AllocationStats	No
AssetTechnicalAvailability	form	List<TurbineAvailabilityStats>	No
AssetContractualAvailability	form	List<TurbineAvailabilityStats>	No
CombinedStatsForDrillDown	form	bool	No
CombinedStatsForTopDashboards	form	bool	No

**AllocationStats** Parameters:
Name	Parameter	Data Type	Required
CategoryId	form	string	No
Category	form	string	No
CategoryGroup	form	string	No
CategorySortIndex	form	byte	No
Duration	form	double	No
DurationPercentage	form	double	No
ErrorRatePercentage	form	int	No
Count	form	int	No
Turbines	form	int	No
Frequency	form	double	No
LostMoney	form	double	No
LostProduction	form	double	No
MTBF	form	double	No
MTTR	form	double	No
DowntimePercentage	form	double	No
AllocatedPercentage	form	double	No
Available	form	bool	No
Excluded	form	int	No
Performance	form	byte	No
TurbineId	form	int?	No

**TurbineAvailabilityStats** Parameters:
Name	Parameter	Data Type	Required
TurbineId	form	int	No
TurbineName	form	string	No
Availability	form	double	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/allocations/{Type}/statistics/from/{From}/to/{To} HTTP/1.1 
Host: mdn.bazefield.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	chartType: String,
	chartBy: String,
	height: 0,
	width: 0,
	turbineIds: 
	[
		String
	],
	sourceIds: 
	[
		String
	],
	categoryIds: 
	[
		String
	],
	type: String,
	from: String,
	to: String,
	orderBy: String,
	thenBy: String,
	allocationCategoriesFilter: 
	[
		String
	],
	take: 0,
	chartGroup: String,
	includeAvailable: False,
	includeExcluded: False,
	inObjectTime: False,
	compatibilityMode: False,
	compatibilityModeForDrillDown: False
}

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

{
	totalAvailability: 0,
	productionAvailability: 0,
	hasDeratedCategories: False,
	totalLostMoney: 0,
	totalLostProduction: 0,
	totalUnavailableLostMoney: 0,
	totalUnavailableProduction: 0,
	totalActualProduction: 0,
	turnoverProduction: 0,
	totalDuration: 0,
	totalCount: 0,
	reportedDuration: 0,
	allocationStatsLostMoney: 0,
	allocationStatsLostProduction: 0,
	allocationStatsDuration: 0,
	allocationStatsTotalCount: 0,
	totalAssetCount: 0,
	allocationStats: 
	[
		{
			categoryId: String,
			category: String,
			categoryGroup: String,
			categorySortIndex: 0,
			duration: 0,
			durationPercentage: 0,
			errorRatePercentage: 0,
			count: 0,
			turbines: 0,
			frequency: 0,
			lostMoney: 0,
			lostProduction: 0,
			mtbf: 0,
			mttr: 0,
			downtimePercentage: 0,
			allocatedPercentage: 0,
			available: False,
			excluded: 0,
			performance: 0,
			turbineId: 0
		}
	],
	mttr: 0,
	mtbf: 0,
	mostFrequent: 
	{
		categoryId: String,
		category: String,
		categoryGroup: String,
		categorySortIndex: 0,
		duration: 0,
		durationPercentage: 0,
		errorRatePercentage: 0,
		count: 0,
		turbines: 0,
		frequency: 0,
		lostMoney: 0,
		lostProduction: 0,
		mtbf: 0,
		mttr: 0,
		downtimePercentage: 0,
		allocatedPercentage: 0,
		available: False,
		excluded: 0,
		performance: 0,
		turbineId: 0
	},
	longestDuration: 
	{
		categoryId: String,
		category: String,
		categoryGroup: String,
		categorySortIndex: 0,
		duration: 0,
		durationPercentage: 0,
		errorRatePercentage: 0,
		count: 0,
		turbines: 0,
		frequency: 0,
		lostMoney: 0,
		lostProduction: 0,
		mtbf: 0,
		mttr: 0,
		downtimePercentage: 0,
		allocatedPercentage: 0,
		available: False,
		excluded: 0,
		performance: 0,
		turbineId: 0
	},
	assetTechnicalAvailability: 
	[
		{
			turbineId: 0,
			turbineName: String,
			availability: 0
		}
	],
	assetContractualAvailability: 
	[
		{
			turbineId: 0,
			turbineName: String,
			availability: 0
		}
	],
	combinedStatsForDrillDown: False,
	combinedStatsForTopDashboards: False
}