| Requires any of the roles: | Riskstore.Write, Riskstore.Admin |
| GET | /api/riskstore/analysis/results | Get the analysis by id, this will return results if the analysis is completed |
|---|
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*
open class GetAnalysisRequest : IGet
{
/**
* The analysis id
*/
@ApiMember(DataType="integer", Description="The analysis id", Format="int64")
open var id:Long? = null
/**
* The legacy analysis id
*/
@ApiMember(DataType="integer", Description="The legacy analysis id", Format="int64")
open var legacyId:Long? = null
/**
* True to not load all deal allocations, analysis runs etc...
*/
@ApiMember(DataType="boolean", Description="True to not load all deal allocations, analysis runs etc...")
open var onlyCoreData:Boolean? = null
}
open class RollupResponse
{
open var analysis:Analysis? = null
open var portfolioMetrics:ArrayList<AnalysisPortfolioMetric>? = null
open var results:ArrayList<AnalysisResult>? = null
open var responseStatus:ResponseStatus? = null
open var unresolvedDealIds:ArrayList<String>? = null
open var unlinkedDealIds:ArrayList<ValueTuple<String,String>>? = null
open var message:String? = null
}
@DataContract
open class Analysis : IObjectWithId
{
@DataMember(Order=1)
override var id:Long? = null
@DataMember(Order=2)
open var name:String? = null
@DataMember(Order=3)
open var modelAsOfDate:Date? = null
@DataMember(Order=4)
open var perspectiveId:Int? = null
@DataMember(Order=5)
open var configurations:ArrayList<AnalysisConfiguration>? = null
@DataMember(Order=6)
open var deals:ArrayList<AnalysisDeal>? = null
@DataMember(Order=7)
open var eventIdFilters:ArrayList<AnalysisEventIdFilter>? = null
@DataMember(Order=8)
open var createdBy:String? = null
@DataMember(Order=9)
open var createdDateUtc:Date? = null
@DataMember(Order=10)
open var completedDateUtc:Date? = null
@DataMember(Order=11)
open var legacyAnalysisId:Long? = null
@DataMember(Order=12)
open var resultPersistenceTracking:ArrayList<MessageTracking>? = null
@DataMember(Order=13)
open var processingStatus:ProcessingStatus? = null
@DataMember(Order=14)
open var saveResults:Boolean? = null
@DataMember(Order=15)
open var eventSourceSystem:String? = null
@DataMember(Order=16)
open var updatedDateUtc:Date? = null
@DataMember(Order=17)
open var isExpired:Boolean? = null
@DataMember(Order=18)
override var rowIdentifier:UUID? = null
@DataMember(Order=19)
open var errorMessage:String? = null
/**
* Take the minimum simulation count when we have different simulations between event sets
*/
@DataMember(Order=20)
@ApiMember(DataType="boolean", Description="Take the minimum simulation count when we have different simulations between event sets")
open var ignoreSimulationCountMismatch:Boolean? = null
@DataMember(Order=21)
@Ignore()
open var finalStatus:ProcessingStatus? = null
}
@DataContract
open class AnalysisConfiguration : IObjectWithId, IHasAnalysisId
{
@DataMember(Order=1)
override var id:Long? = null
@DataMember(Order=2)
override var analysisId:Long? = null
@DataMember(Order=3)
open var windowStartDate:Date? = null
@DataMember(Order=4)
open var windowEndDate:Date? = null
@DataMember(Order=5)
open var standardEnabled:Boolean? = null
@DataMember(Order=6)
open var runOffEnabled:Boolean? = null
@DataMember(Order=7)
open var aggregateEnabled:Boolean? = null
@DataMember(Order=8)
open var occurrenceEnabled:Boolean? = null
@DataMember(Order=9)
open var nettEnabled:Boolean? = null
@DataMember(Order=10)
open var grossEnabled:Boolean? = null
@DataMember(Order=11)
open var tailIntensityPercentageStart:BigDecimal? = null
@DataMember(Order=12)
open var tailIntensityPercentageEnd:BigDecimal? = null
@DataMember(Order=13)
open var metaRiskId:Int? = null
@DataMember(Order=14)
open var outputLevel:ResultOutputLevel? = null
@DataMember(Order=15)
open var processingStatus:ProcessingStatus? = null
@DataMember(Order=16)
open var eventLossFloorStartRange:BigDecimal? = null
@DataMember(Order=17)
open var eventLossFloorEndRange:BigDecimal? = null
@DataMember(Order=18)
open var analysisPortfolioEventSetConfigurations:ArrayList<AnalysisPortfolioEventSetConfiguration>? = null
@DataMember(Order=19)
override var rowIdentifier:UUID? = null
}
enum class ResultOutputLevel
{
NotSet,
PortfolioMetrics,
Curve,
Ylt,
TailIntensity,
DealYlt,
DealElt,
DealEltWithIndustryLoss,
PortfolioElt,
PortfolioEltWithIndustryLoss,
EventSetGeneration,
PortfolioRaps,
DealRaps,
PortfolioSepyIndustryLoss,
DealSepyIndustryLoss,
}
enum class ProcessingStatus(val value:Int)
{
New(0),
Processing(1),
Failed(10),
Successful(20),
}
open class AnalysisPortfolioEventSetConfiguration : IObjectWithId, IHasAnalysisId
{
@DataMember(Order=1)
override var id:Long? = null
@DataMember(Order=2)
override var analysisId:Long? = null
@DataMember(Order=3)
open var analysisConfigurationId:Long? = null
@DataMember(Order=4)
open var portfolioName:String? = null
@DataMember(Order=5)
open var modelId:String? = null
@DataMember(Order=6)
override var rowIdentifier:UUID? = null
}
@DataContract
open class AnalysisDeal : IObjectWithId, IHasAnalysisId
{
@DataMember(Order=1)
override var id:Long? = null
@DataMember(Order=2)
override var analysisId:Long? = null
@DataMember(Order=3)
open var sourceDealId:String? = null
@DataMember(Order=4)
open var dealRef:String? = null
@DataMember(Order=5)
open var sourceDealSystem:String? = null
@DataMember(Order=6)
open var eventSetId:Long? = null
@DataMember(Order=7)
open var rol:Double? = null
@DataMember(Order=8)
open var limit:Double? = null
@DataMember(Order=9)
open var inceptionDate:Date? = null
@DataMember(Order=10)
open var expiryDate:Date? = null
@DataMember(Order=11)
open var transactionType:TransactionType? = null
@DataMember(Order=12)
open var allocations:ArrayList<AnalysisPortfolioAllocation>? = null
@DataMember(Order=13)
open var perspectiveIdOverride:Int? = null
@DataMember(Order=14)
open var eventSetIdOverride:Long? = null
@DataMember(Order=15)
open var modelAsOfDateOverride:Date? = null
@DataMember(Order=16)
open var sourceModelSystemOverride:String? = null
@DataMember(Order=17)
open var sourceModelIdOverride:String? = null
@DataMember(Order=18)
open var sourceEventSetIdOverride:String? = null
@DataMember(Order=19)
open var eventSourceSystemOverride:String? = null
@DataMember(Order=20)
override var rowIdentifier:UUID? = null
}
enum class TransactionType
{
NotSet,
S,
B,
}
@DataContract
open class AnalysisPortfolioAllocation : IObjectWithId
{
@DataMember(Order=1)
override var id:Long? = null
@DataMember(Order=2)
open var analysisDealId:Long? = null
@DataMember(Order=3)
@Validate(Validator="NotEmpty", Message="PortfolioName is mandatory")
open var portfolioName:String? = null
@DataMember(Order=4)
open var allocationPercentage:Double? = null
@DataMember(Order=5)
override var rowIdentifier:UUID? = null
}
@DataContract
open class AnalysisEventIdFilter : IObjectWithId, IHasAnalysisId
{
@DataMember(Order=1)
override var id:Long? = null
@DataMember(Order=2)
override var analysisId:Long? = null
@DataMember(Order=3)
open var eventSourceId:Int? = null
@DataMember(Order=4)
open var eventId:Long? = null
@DataMember(Order=5)
override var rowIdentifier:UUID? = null
}
@DataContract
open class MessageTracking
{
@DataMember(Order=1)
open var id:UUID? = null
@DataMember(Order=2)
open var analysisId:Long? = null
@DataMember(Order=3)
open var processingStatus:ProcessingStatus? = null
@DataMember(Order=4)
open var messageType:MessageType? = null
@DataMember(Order=5)
open var createdDateUtc:Date? = null
@DataMember(Order=6)
open var updatedDateUtc:Date? = null
}
enum class MessageType
{
NotSet,
Persistence,
Archival,
}
open class AnalysisPortfolioMetric : IHasAnalysisResultId
{
open var analysisType:AnalysisType? = null
open var simulationLossPerspective:SimulationLossPerspective? = null
open var reinsurancePremiumLossType:ReinsurancePremiumLossType? = null
open var metricDescription:String? = null
open var portfolioName:String? = null
open var metric:Double? = null
open var metaRiskId:Int? = null
open var simulation:Int? = null
override var analysisResultId:Long? = null
}
enum class AnalysisType
{
NotSet,
Standard,
RunOff,
}
enum class SimulationLossPerspective
{
NotSet,
Agg,
Occ,
}
enum class ReinsurancePremiumLossType
{
NotSet,
Net,
Gross,
}
@DataContract
open class AnalysisResult : IObjectWithId
{
@DataMember(Order=1)
override var id:Long? = null
@DataMember(Order=2)
open var analysisId:Long? = null
@DataMember(Order=3)
open var analysisConfigurationId:Long? = null
@DataMember(Order=4)
open var container:String? = null
@DataMember(Order=5)
open var blobName:String? = null
@DataMember(Order=6)
open var resultTableName:String? = null
@DataMember(Order=7)
open var analysisType:AnalysisType? = null
@DataMember(Order=8)
open var simulationLossPerspective:SimulationLossPerspective? = null
@DataMember(Order=9)
open var reinsurancePremiumLossType:ReinsurancePremiumLossType? = null
@DataMember(Order=10)
open var outputLevel:ResultOutputLevel? = null
@DataMember(Order=11)
open var metaRiskId:Int? = null
@DataMember(Order=12)
open var analysisPortfolioEventSetResults:ArrayList<AnalysisPortfolioEventSetResult>? = null
@DataMember(Order=13)
override var rowIdentifier:UUID? = null
}
open class AnalysisPortfolioEventSetResult : IObjectWithId, IHasAnalysisId
{
@DataMember(Order=1)
override var id:Long? = null
@DataMember(Order=2)
override var analysisId:Long? = null
@DataMember(Order=3)
open var analysisPortfolioEventSetConfigurationId:Long? = null
@DataMember(Order=4)
open var analysisResultId:Long? = null
@DataMember(Order=5)
open var portfolioName:String? = null
@DataMember(Order=6)
override var rowIdentifier:UUID? = null
}
Kotlin GetAnalysisRequest DTOs
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 /api/riskstore/analysis/results HTTP/1.1 Host: riskstoreng-dev.nephila.com Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
analysis:
{
id: 0,
name: String,
modelAsOfDate: 0001-01-01,
perspectiveId: 0,
configurations:
[
{
id: 0,
analysisId: 0,
windowStartDate: 0001-01-01,
windowEndDate: 0001-01-01,
standardEnabled: False,
runOffEnabled: False,
aggregateEnabled: False,
occurrenceEnabled: False,
nettEnabled: False,
grossEnabled: False,
tailIntensityPercentageStart: 0,
tailIntensityPercentageEnd: 0,
metaRiskId: 0,
outputLevel: NotSet,
processingStatus: New,
eventLossFloorStartRange: 0,
eventLossFloorEndRange: 0,
analysisPortfolioEventSetConfigurations:
[
{
id: 0,
analysisId: 0,
analysisConfigurationId: 0,
portfolioName: String,
modelId: String,
rowIdentifier: 00000000000000000000000000000000
}
],
rowIdentifier: 00000000000000000000000000000000
}
],
deals:
[
{
id: 0,
analysisId: 0,
sourceDealId: String,
dealRef: String,
sourceDealSystem: String,
eventSetId: 0,
rol: 0,
limit: 0,
inceptionDate: 0001-01-01,
expiryDate: 0001-01-01,
transactionType: NotSet,
allocations:
[
{
id: 0,
analysisDealId: 0,
portfolioName: String,
allocationPercentage: 0,
rowIdentifier: 00000000000000000000000000000000
}
],
perspectiveIdOverride: 0,
eventSetIdOverride: 0,
modelAsOfDateOverride: 0001-01-01,
sourceModelSystemOverride: String,
sourceModelIdOverride: String,
sourceEventSetIdOverride: String,
eventSourceSystemOverride: String,
rowIdentifier: 00000000000000000000000000000000
}
],
eventIdFilters:
[
{
id: 0,
analysisId: 0,
eventSourceId: 0,
eventId: 0,
rowIdentifier: 00000000000000000000000000000000
}
],
createdBy: String,
createdDateUtc: 0001-01-01,
completedDateUtc: 0001-01-01,
legacyAnalysisId: 0,
resultPersistenceTracking:
[
{
id: 00000000000000000000000000000000,
analysisId: 0,
processingStatus: New,
messageType: NotSet,
createdDateUtc: 0001-01-01,
updatedDateUtc: 0001-01-01
}
],
processingStatus: New,
saveResults: False,
eventSourceSystem: String,
updatedDateUtc: 0001-01-01,
isExpired: False,
rowIdentifier: 00000000000000000000000000000000,
errorMessage: String,
ignoreSimulationCountMismatch: False,
finalStatus: New
},
portfolioMetrics:
[
{
analysisType: NotSet,
simulationLossPerspective: NotSet,
reinsurancePremiumLossType: NotSet,
metricDescription: String,
portfolioName: String,
metric: 0,
metaRiskId: 0,
simulation: 0,
analysisResultId: 0
}
],
results:
[
{
id: 0,
analysisId: 0,
analysisConfigurationId: 0,
container: String,
blobName: String,
resultTableName: String,
analysisType: NotSet,
simulationLossPerspective: NotSet,
reinsurancePremiumLossType: NotSet,
outputLevel: NotSet,
metaRiskId: 0,
analysisPortfolioEventSetResults:
[
{
id: 0,
analysisId: 0,
analysisPortfolioEventSetConfigurationId: 0,
analysisResultId: 0,
portfolioName: String,
rowIdentifier: 00000000000000000000000000000000
}
],
rowIdentifier: 00000000000000000000000000000000
}
],
responseStatus:
{
errorCode: String,
message: String,
stackTrace: String,
errors:
[
{
errorCode: String,
fieldName: String,
message: String,
meta:
{
String: String
}
}
],
meta:
{
String: String
}
},
unresolvedDealIds:
[
String
],
unlinkedDealIds:
[
"(, )"
],
message: String
}