| GET | /allocations/{Id} |
|---|
namespace Bazefield.Allocations.DataModel.Entities
open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
[<AllowNullLiteral>]
type AlarmCode() =
member val EventNumber:Int32 = new Int32() with get,set
member val Parameter1:Nullable<Int32> = new Nullable<Int32>() with get,set
member val VendorEventType:String = null with get,set
[<AllowNullLiteral>]
type Alarm() =
member val Id:Int32 = new Int32() with get,set
member val Code:Int32 = new Int32() with get,set
member val AlarmCode:AlarmCode = null with get,set
member val Name:String = null with get,set
member val BrakePrg:Int32 = new Int32() with get,set
member val CanTriggerAllocation:Boolean = new Boolean() with get,set
member val Description:String = null with get,set
member val Remarks:String = null with get,set
member val ResetPrg:Char = new Char() with get,set
member val IsOkAlarm:Boolean = new Boolean() with get,set
member val Meta:Dictionary<String, String> = null with get,set
member val AlarmType:Byte = new Byte() with get,set
member val Type:String = null with get,set
[<AllowNullLiteral>]
type TriggerAlarm() =
member val Alarm:Alarm = null with get,set
member val Start:DateTime = new DateTime() with get,set
member val End:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val LogId:Int32 = new Int32() with get,set
member val SfId:String = null with get,set
[<AllowNullLiteral>]
type AllocationCategory() =
member val Id:Int32 = new Int32() with get,set
member val Name:String = null with get,set
member val Acronym:String = null with get,set
member val Color:String = null with get,set
member val Uncategorized:Boolean = new Boolean() with get,set
member val Available:Boolean = new Boolean() with get,set
member val TypeId:Int32 = new Int32() with get,set
member val Group:String = null with get,set
member val SortIndex:Byte = new Byte() with get,set
member val Priority:Int32 = new Int32() with get,set
member val Enabled:Boolean = new Boolean() with get,set
member val Performance:Byte = new Byte() with get,set
member val Excluded:Int32 = new Int32() with get,set
member val ParentCategoryId:Nullable<Int32> = new Nullable<Int32>() with get,set
member val ParentCategoryName:String = null with get,set
member val Code:String = null with get,set
member val VariantAlias:String = null with get,set
member val Attributes:Dictionary<String, String> = null with get,set
[<AllowNullLiteral>]
type AllocationType() =
member val Id:Int32 = new Int32() with get,set
member val Name:String = null with get,set
member val Acronym:String = null with get,set
member val Version:String = null with get,set
member val Description:String = null with get,set
member val SortOrder:Int32 = new Int32() with get,set
member val LinkedTypeId:Nullable<Int32> = new Nullable<Int32>() with get,set
member val SubType:Nullable<Boolean> = new Nullable<Boolean>() with get,set
member val GroupName:String = null with get,set
member val DefaultVisible:Boolean = new Boolean() with get,set
member val DomainId:Nullable<Int32> = new Nullable<Int32>() with get,set
member val Disabled:Boolean = new Boolean() with get,set
member val Matrix:String = null with get,set
member val Certified:Nullable<Boolean> = new Nullable<Boolean>() with get,set
member val AllocationTypeClassId:Int32 = new Int32() with get,set
member val VariantOfAbstractTypeId:Nullable<Int32> = new Nullable<Int32>() with get,set
[<AllowNullLiteral>]
type AllocationCategoryWithType() =
inherit AllocationCategory()
member val AllocationType:AllocationType = null with get,set
[<AllowNullLiteral>]
type AllocationPropertyValue() =
member val Name:String = null with get,set
member val DisplayName:String = null with get,set
member val Value:Double = new Double() with get,set
member val LimitedValue:Nullable<Double> = new Nullable<Double>() with get,set
member val Unit:String = null with get,set
member val IsOverride:Boolean = new Boolean() with get,set
member val Description:String = null with get,set
type CommentType =
| Turbine = 0
| Allocation = 1
| Alarm = 2
type LabelType =
| Allocation = 1
| Other = 2
| Alarm = 3
| Case = 4
[<AllowNullLiteral>]
type Label() =
member val Id:Int32 = new Int32() with get,set
member val Name:String = null with get,set
member val Color:String = null with get,set
member val Type:Nullable<LabelType> = new Nullable<LabelType>() with get,set
[<AllowNullLiteral>]
type Comment() =
member val Id:Int32 = new Int32() with get,set
member val TurbineId:Nullable<Int32> = new Nullable<Int32>() with get,set
member val TurbineName:String = null with get,set
member val TimeStamp:DateTime = new DateTime() with get,set
member val Text:String = null with get,set
member val CreatedBy:String = null with get,set
member val CreatedById:Nullable<Decimal> = new Nullable<Decimal>() with get,set
member val LastModified:DateTime = new DateTime() with get,set
member val Type:CommentType = new CommentType() with get,set
member val External:Nullable<Boolean> = new Nullable<Boolean>() with get,set
member val Sticky:Nullable<Boolean> = new Nullable<Boolean>() with get,set
member val AllocationId:Nullable<Int32> = new Nullable<Int32>() with get,set
member val AlarmLogId:Nullable<Int32> = new Nullable<Int32>() with get,set
member val AlarmId:Nullable<Int32> = new Nullable<Int32>() with get,set
member val CommandId:Nullable<Int32> = new Nullable<Int32>() with get,set
member val RelatedInfo:String = null with get,set
member val Cleared:Boolean = new Boolean() with get,set
member val Labels:ResizeArray<Label> = null with get,set
member val ObjectId:String = null with get,set
member val RelatedStart:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val RelatedEnd:Nullable<DateTime> = new Nullable<DateTime>() with get,set
[<AllowNullLiteral>]
type Allocation() =
member val Id:Int32 = new Int32() with get,set
member val TurbineId:Int32 = new Int32() with get,set
member val ObjectId:String = null with get,set
member val TurbineName:String = null with get,set
member val TurbineTitle:String = null with get,set
member val SourceId:Int32 = new Int32() with get,set
member val SourceName:String = null with get,set
member val RootCause:String = null with get,set
member val TriggeredByAlarm:TriggerAlarm = null with get,set
member val Category:AllocationCategoryWithType = null with get,set
member val Categories:ResizeArray<AllocationCategoryWithType> = null with get,set
member val Start:DateTime = new DateTime() with get,set
member val End:DateTime = new DateTime() with get,set
member val Start_Local:DateTimeOffset = new DateTimeOffset() with get,set
member val End_Local:DateTimeOffset = new DateTimeOffset() with get,set
member val Duration:TimeSpan = new TimeSpan() with get,set
member val LastModified:DateTime = new DateTime() with get,set
member val IsUnclassified:Boolean = new Boolean() with get,set
member val ManualOverrideLoss:Nullable<Boolean> = new Nullable<Boolean>() with get,set
member val ResponseTime:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val LostProduction:Nullable<Double> = new Nullable<Double>() with get,set
member val LostProdutionFiltered:Nullable<Double> = new Nullable<Double>() with get,set
member val LostMoney:Nullable<Double> = new Nullable<Double>() with get,set
member val LostMoneyFiltered:Nullable<Double> = new Nullable<Double>() with get,set
member val Properties:ResizeArray<AllocationPropertyValue> = null with get,set
member val Finished:Boolean = new Boolean() with get,set
member val Manual:Boolean = new Boolean() with get,set
member val Overridden:Boolean = new Boolean() with get,set
member val Reallocated:Boolean = new Boolean() with get,set
member val Pending:Boolean = new Boolean() with get,set
member val ChangeLog:String = null with get,set
member val LastComment:Comment = null with get,set
member val Exported:String = null with get,set
member val Labels:ResizeArray<Label> = null with get,set
member val Suspect:Nullable<Boolean> = new Nullable<Boolean>() with get,set
member val Uncertain:Boolean = new Boolean() with get,set
member val EventId:Nullable<Int32> = new Nullable<Int32>() with get,set
member val HasEvent:Boolean = new Boolean() with get,set
member val HoldCategory:Boolean = new Boolean() with get,set
member val Approved:Boolean = new Boolean() with get,set
member val SfId:String = null with get,set
member val FirstAlarmSfId:String = null with get,set
member val RootCauseAlarmId:Nullable<Int32> = new Nullable<Int32>() with get,set
[<AllowNullLiteral>]
type GetAllocation() =
member val Id:Int32 = new Int32() with get,set
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=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: P739710DT15H28M36.5325317S,
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
}