BazeField Services

<back to all web services

GetAllocations

Allocations API
Requires Authentication
The following routes are available for this service:
GET/api/allocations/ids/{Ids}
GetAllocations Parameters:
NameParameterData TypeRequiredDescription
IdspathList<int>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.

GET /api/allocations/ids/{Ids} HTTP/1.1 
Host: mdn.bazefield.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
		},
		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: 
		[
			{
				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,
		start_Local: 0001-01-01T00:00:00.0000000+00:00,
		end_Local: 0001-01-01T00:00:00.0000000+00:00,
		duration: P739369DT14H23M16.8378601S,
		isUnclassified: False,
		manualOverrideLoss: False,
		responseTime: 0001-01-01,
		lostProduction: 0,
		lostMoney: 0,
		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
	}
]