Nephila RiskStore

<back to all web services

FindAnalysisRequest

General
Requires Authentication
Requires any of the roles:Riskstore.Write, Riskstore.Admin
The following routes are available for this service:
GET/api/riskstore/analysisSearch for analyses
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*


open class FindAnalysisRequest : QueryDb<Analysis>()
{
    /**
    * The Ids of the Analyses
    */
    @ApiMember(DataType="integer", Description="The Ids of the Analyses", Format="int64")
    open var ids:ArrayList<Long>? = null

    /**
    * The partial name of the analyses
    */
    @ApiMember(DataType="string", Description="The partial name of the analyses")
    open var name:String? = null

    /**
    * Filter only Standard analysis type
    */
    @ApiMember(DataType="boolean", Description="Filter only Standard analysis type")
    open var standardEnabled:Boolean? = null

    /**
    * Filter only Run Off analysis type
    */
    @ApiMember(DataType="boolean", Description="Filter only Run Off analysis type")
    open var runOffEnabled:Boolean? = null

    /**
    * The perspective id used for the analysis
    */
    @ApiMember(DataType="integer", Description="The perspective id used for the analysis", Format="int32")
    open var perspectiveId:Int? = null

    /**
    * The partial name of the user who run the analysis
    */
    @ApiMember(DataType="string", Description="The partial name of the user who run the analysis")
    open var createdBy:String? = null

    /**
    * The analysis run date to filter from
    */
    @ApiMember(DataType="string", Description="The analysis run date to filter from", Format="date-time")
    open var analysisRunFromDateTime:Date? = null

    /**
    * The analysis run date to filter to
    */
    @ApiMember(DataType="string", Description="The analysis run date to filter to", Format="date-time")
    open var analysisRunToDateTime:Date? = null

    /**
    * The status of the analysis. 1 = Processing, 10 = Failed, 20 = Successful
    */
    @ApiMember(DataType="integer", Description="The status of the analysis. 1 = Processing, 10 = Failed, 20 = Successful", Format="int32")
    open var processingStatus:ProcessingStatus? = null
}

open class QueryDb<T> : QueryBase()
{
}

@DataContract
open class QueryBase
{
    @DataMember(Order=1)
    open var skip:Int? = null

    @DataMember(Order=2)
    open var take:Int? = null

    @DataMember(Order=3)
    open var orderBy:String? = null

    @DataMember(Order=4)
    open var orderByDesc:String? = null

    @DataMember(Order=5)
    open var include:String? = null

    @DataMember(Order=6)
    open var fields:String? = null

    @DataMember(Order=7)
    open var meta:HashMap<String,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,
}

@DataContract
open class QueryResponse<T>
{
    @DataMember(Order=1)
    open var offset:Int? = null

    @DataMember(Order=2)
    open var total:Int? = null

    @DataMember(Order=3)
    open var results:ArrayList<Analysis>? = null

    @DataMember(Order=4)
    open var meta:HashMap<String,String>? = null

    @DataMember(Order=5)
    open var responseStatus:ResponseStatus? = null
}

Kotlin FindAnalysisRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /api/riskstore/analysis HTTP/1.1 
Host: riskstoreng-dev.nephila.com 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"offset":0,"total":0,"results":[{"id":0,"name":"String","modelAsOfDate":"0001-01-01T00:00:00.0000000Z","perspectiveId":0,"configurations":[{"id":0,"analysisId":0,"windowStartDate":"0001-01-01T00:00:00.0000000Z","windowEndDate":"0001-01-01T00:00:00.0000000Z","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-01T00:00:00.0000000Z","expiryDate":"0001-01-01T00:00:00.0000000Z","transactionType":"NotSet","allocations":[{"id":0,"analysisDealId":0,"portfolioName":"String","allocationPercentage":0,"rowIdentifier":"00000000000000000000000000000000"}],"perspectiveIdOverride":0,"eventSetIdOverride":0,"modelAsOfDateOverride":"0001-01-01T00:00:00.0000000Z","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-01T00:00:00.0000000Z","completedDateUtc":"0001-01-01T00:00:00.0000000Z","legacyAnalysisId":0,"resultPersistenceTracking":[{"id":"00000000000000000000000000000000","analysisId":0,"processingStatus":"New","messageType":"NotSet","createdDateUtc":"0001-01-01T00:00:00.0000000Z","updatedDateUtc":"0001-01-01T00:00:00.0000000Z"}],"processingStatus":"New","saveResults":false,"eventSourceSystem":"String","updatedDateUtc":"0001-01-01T00:00:00.0000000Z","isExpired":false,"rowIdentifier":"00000000000000000000000000000000","errorMessage":"String","ignoreSimulationCountMismatch":false,"finalStatus":"New"}],"meta":{"String":"String"},"responseStatus":{"__type":"ServiceStack.ResponseStatus, ServiceStack.Interfaces","errorCode":"String","message":"String","stackTrace":"String","errors":[{"__type":"ServiceStack.ResponseError, ServiceStack.Interfaces","errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}