Nephila RiskStore

FindAnalysisRequest

General

**Requires Authentication**
Requires any of the roles:	Riskstore.Write, Riskstore.Admin

The following routes are available for this service:
GET	/api/riskstore/analysis	Search for analyses

Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Nephila.RiskStore.ServiceModel.Requests
Imports Nephila.RiskStore.ServiceModel.Types
Imports Nephila.RiskStore.ServiceModel

Namespace Global

    Namespace Nephila.RiskStore.ServiceModel.Requests

        Public Partial Class FindAnalysisRequest
            Inherits QueryDb(Of Analysis)
            '''<Summary>
            '''The Ids of the Analyses
            '''</Summary>
            <ApiMember(DataType:="integer", Description:="The Ids of the Analyses", Format:="int64")>
            Public Overridable Property Ids As Long()

            '''<Summary>
            '''The partial name of the analyses
            '''</Summary>
            <ApiMember(DataType:="string", Description:="The partial name of the analyses")>
            Public Overridable Property Name As String

            '''<Summary>
            '''Filter only Standard analysis type
            '''</Summary>
            <ApiMember(DataType:="boolean", Description:="Filter only Standard analysis type")>
            Public Overridable Property StandardEnabled As Boolean?

            '''<Summary>
            '''Filter only Run Off analysis type
            '''</Summary>
            <ApiMember(DataType:="boolean", Description:="Filter only Run Off analysis type")>
            Public Overridable Property RunOffEnabled As Boolean?

            '''<Summary>
            '''The perspective id used for the analysis
            '''</Summary>
            <ApiMember(DataType:="integer", Description:="The perspective id used for the analysis", Format:="int32")>
            Public Overridable Property PerspectiveId As Integer?

            '''<Summary>
            '''The partial name of the user who run the analysis
            '''</Summary>
            <ApiMember(DataType:="string", Description:="The partial name of the user who run the analysis")>
            Public Overridable Property CreatedBy As String

            '''<Summary>
            '''The analysis run date to filter from
            '''</Summary>
            <ApiMember(DataType:="string", Description:="The analysis run date to filter from", Format:="date-time")>
            Public Overridable Property AnalysisRunFromDateTime As Date?

            '''<Summary>
            '''The analysis run date to filter to
            '''</Summary>
            <ApiMember(DataType:="string", Description:="The analysis run date to filter to", Format:="date-time")>
            Public Overridable Property AnalysisRunToDateTime As Date?

            '''<Summary>
            '''The status of the analysis. 1 = Processing, 10 = Failed, 20 = Successful
            '''</Summary>
            <ApiMember(DataType:="integer", Description:="The status of the analysis. 1 = Processing, 10 = Failed, 20 = Successful", Format:="int32")>
            Public Overridable Property ProcessingStatus As ProcessingStatus?
        End Class
    End Namespace

    Namespace Nephila.RiskStore.ServiceModel.Types

        <DataContract>
        Public Partial Class Analysis
            Implements IObjectWithId
            <DataMember(Order:=1)>
            Public Overridable Property Id As Long Implements IObjectWithId.Id

            <DataMember(Order:=2)>
            Public Overridable Property Name As String

            <DataMember(Order:=3)>
            Public Overridable Property ModelAsOfDate As Date?

            <DataMember(Order:=4)>
            Public Overridable Property PerspectiveId As Integer

            <DataMember(Order:=5)>
            Public Overridable Property Configurations As List(Of AnalysisConfiguration)

            <DataMember(Order:=6)>
            Public Overridable Property Deals As List(Of AnalysisDeal)

            <DataMember(Order:=7)>
            Public Overridable Property EventIdFilters As List(Of AnalysisEventIdFilter)

            <DataMember(Order:=8)>
            Public Overridable Property CreatedBy As String

            <DataMember(Order:=9)>
            Public Overridable Property CreatedDateUtc As Date

            <DataMember(Order:=10)>
            Public Overridable Property CompletedDateUtc As Date?

            <DataMember(Order:=11)>
            Public Overridable Property LegacyAnalysisId As Long?

            <DataMember(Order:=12)>
            Public Overridable Property ResultPersistenceTracking As List(Of MessageTracking)

            <DataMember(Order:=13)>
            Public Overridable Property ProcessingStatus As ProcessingStatus

            <DataMember(Order:=14)>
            Public Overridable Property SaveResults As Boolean

            <DataMember(Order:=15)>
            Public Overridable Property EventSourceSystem As String

            <DataMember(Order:=16)>
            Public Overridable Property UpdatedDateUtc As Date

            <DataMember(Order:=17)>
            Public Overridable Property IsExpired As Boolean

            <DataMember(Order:=18)>
            Public Overridable Property RowIdentifier As Guid Implements IObjectWithId.RowIdentifier

            <DataMember(Order:=19)>
            Public Overridable Property ErrorMessage As String

            '''<Summary>
            '''Take the minimum simulation count when we have different simulations between event sets
            '''</Summary>
            <DataMember(Order:=20)>
            <ApiMember(DataType:="boolean", Description:="Take the minimum simulation count when we have different simulations between event sets")>
            Public Overridable Property IgnoreSimulationCountMismatch As Boolean

            <DataMember(Order:=21)>
            <Ignore>
            Public Overridable Property FinalStatus As ProcessingStatus
        End Class

        <DataContract>
        Public Partial Class AnalysisConfiguration
            Implements IObjectWithId
            Implements IHasAnalysisId
            <DataMember(Order:=1)>
            Public Overridable Property Id As Long Implements IObjectWithId.Id

            <DataMember(Order:=2)>
            Public Overridable Property AnalysisId As Long Implements IHasAnalysisId.AnalysisId

            <DataMember(Order:=3)>
            Public Overridable Property WindowStartDate As Date?

            <DataMember(Order:=4)>
            Public Overridable Property WindowEndDate As Date?

            <DataMember(Order:=5)>
            Public Overridable Property StandardEnabled As Boolean

            <DataMember(Order:=6)>
            Public Overridable Property RunOffEnabled As Boolean

            <DataMember(Order:=7)>
            Public Overridable Property AggregateEnabled As Boolean

            <DataMember(Order:=8)>
            Public Overridable Property OccurrenceEnabled As Boolean

            <DataMember(Order:=9)>
            Public Overridable Property NettEnabled As Boolean

            <DataMember(Order:=10)>
            Public Overridable Property GrossEnabled As Boolean

            <DataMember(Order:=11)>
            Public Overridable Property TailIntensityPercentageStart As Decimal?

            <DataMember(Order:=12)>
            Public Overridable Property TailIntensityPercentageEnd As Decimal?

            <DataMember(Order:=13)>
            Public Overridable Property MetaRiskId As Integer

            <DataMember(Order:=14)>
            Public Overridable Property OutputLevel As ResultOutputLevel

            <DataMember(Order:=15)>
            Public Overridable Property ProcessingStatus As ProcessingStatus

            <DataMember(Order:=16)>
            Public Overridable Property EventLossFloorStartRange As Decimal?

            <DataMember(Order:=17)>
            Public Overridable Property EventLossFloorEndRange As Decimal?

            <DataMember(Order:=18)>
            Public Overridable Property AnalysisPortfolioEventSetConfigurations As List(Of AnalysisPortfolioEventSetConfiguration)

            <DataMember(Order:=19)>
            Public Overridable Property RowIdentifier As Guid Implements IObjectWithId.RowIdentifier
        End Class

        <DataContract>
        Public Partial Class AnalysisDeal
            Implements IObjectWithId
            Implements IHasAnalysisId
            <DataMember(Order:=1)>
            Public Overridable Property Id As Long Implements IObjectWithId.Id

            <DataMember(Order:=2)>
            Public Overridable Property AnalysisId As Long Implements IHasAnalysisId.AnalysisId

            <DataMember(Order:=3)>
            Public Overridable Property SourceDealId As String

            <DataMember(Order:=4)>
            Public Overridable Property DealRef As String

            <DataMember(Order:=5)>
            Public Overridable Property SourceDealSystem As String

            <DataMember(Order:=6)>
            Public Overridable Property EventSetId As Long

            <DataMember(Order:=7)>
            Public Overridable Property ROL As Double

            <DataMember(Order:=8)>
            Public Overridable Property Limit As Double

            <DataMember(Order:=9)>
            Public Overridable Property InceptionDate As Date

            <DataMember(Order:=10)>
            Public Overridable Property ExpiryDate As Date

            <DataMember(Order:=11)>
            Public Overridable Property TransactionType As TransactionType

            <DataMember(Order:=12)>
            Public Overridable Property Allocations As List(Of AnalysisPortfolioAllocation)

            <DataMember(Order:=13)>
            Public Overridable Property PerspectiveIdOverride As Integer?

            <DataMember(Order:=14)>
            Public Overridable Property EventSetIdOverride As Long?

            <DataMember(Order:=15)>
            Public Overridable Property ModelAsOfDateOverride As Date?

            <DataMember(Order:=16)>
            Public Overridable Property SourceModelSystemOverride As String

            <DataMember(Order:=17)>
            Public Overridable Property SourceModelIdOverride As String

            <DataMember(Order:=18)>
            Public Overridable Property SourceEventSetIdOverride As String

            <DataMember(Order:=19)>
            Public Overridable Property EventSourceSystemOverride As String

            <DataMember(Order:=20)>
            Public Overridable Property RowIdentifier As Guid Implements IObjectWithId.RowIdentifier
        End Class

        <DataContract>
        Public Partial Class AnalysisEventIdFilter
            Implements IObjectWithId
            Implements IHasAnalysisId
            <DataMember(Order:=1)>
            Public Overridable Property Id As Long Implements IObjectWithId.Id

            <DataMember(Order:=2)>
            Public Overridable Property AnalysisId As Long Implements IHasAnalysisId.AnalysisId

            <DataMember(Order:=3)>
            Public Overridable Property EventSourceId As Integer

            <DataMember(Order:=4)>
            Public Overridable Property EventId As Long

            <DataMember(Order:=5)>
            Public Overridable Property RowIdentifier As Guid Implements IObjectWithId.RowIdentifier
        End Class

        <DataContract>
        Public Partial Class AnalysisPortfolioAllocation
            Implements IObjectWithId
            <DataMember(Order:=1)>
            Public Overridable Property Id As Long Implements IObjectWithId.Id

            <DataMember(Order:=2)>
            Public Overridable Property AnalysisDealId As Long

            <DataMember(Order:=3)>
            <Validate(Validator:="NotEmpty", Message:="PortfolioName is mandatory")>
            Public Overridable Property PortfolioName As String

            <DataMember(Order:=4)>
            Public Overridable Property AllocationPercentage As Double

            <DataMember(Order:=5)>
            Public Overridable Property RowIdentifier As Guid Implements IObjectWithId.RowIdentifier
        End Class

        Public Partial Class AnalysisPortfolioEventSetConfiguration
            Implements IObjectWithId
            Implements IHasAnalysisId
            <DataMember(Order:=1)>
            Public Overridable Property Id As Long Implements IObjectWithId.Id

            <DataMember(Order:=2)>
            Public Overridable Property AnalysisId As Long Implements IHasAnalysisId.AnalysisId

            <DataMember(Order:=3)>
            Public Overridable Property AnalysisConfigurationId As Long

            <DataMember(Order:=4)>
            Public Overridable Property PortfolioName As String

            <DataMember(Order:=5)>
            Public Overridable Property ModelId As String

            <DataMember(Order:=6)>
            Public Overridable Property RowIdentifier As Guid Implements IObjectWithId.RowIdentifier
        End Class

        <DataContract>
        Public Partial Class MessageTracking
            <DataMember(Order:=1)>
            Public Overridable Property Id As Guid

            <DataMember(Order:=2)>
            Public Overridable Property AnalysisId As Long?

            <DataMember(Order:=3)>
            Public Overridable Property ProcessingStatus As ProcessingStatus

            <DataMember(Order:=4)>
            Public Overridable Property MessageType As MessageType

            <DataMember(Order:=5)>
            Public Overridable Property CreatedDateUtc As Date

            <DataMember(Order:=6)>
            Public Overridable Property UpdatedDateUtc As Date
        End Class
    End Namespace

    Namespace ServiceStack

        <DataContract>
        Public Partial Class QueryBase
            <DataMember(Order:=1)>
            Public Overridable Property Skip As Integer?

            <DataMember(Order:=2)>
            Public Overridable Property Take As Integer?

            <DataMember(Order:=3)>
            Public Overridable Property OrderBy As String

            <DataMember(Order:=4)>
            Public Overridable Property OrderByDesc As String

            <DataMember(Order:=5)>
            Public Overridable Property Include As String

            <DataMember(Order:=6)>
            Public Overridable Property Fields As String

            <DataMember(Order:=7)>
            Public Overridable Property Meta As Dictionary(Of String, String)
        End Class

        Public Partial Class QueryDb(Of T)
            Inherits QueryBase
        End Class

        <DataContract>
        Public Partial Class QueryResponse(Of T)
            <DataMember(Order:=1)>
            Public Overridable Property Offset As Integer

            <DataMember(Order:=2)>
            Public Overridable Property Total As Integer

            <DataMember(Order:=3)>
            Public Overridable Property Results As List(Of Analysis)

            <DataMember(Order:=4)>
            Public Overridable Property Meta As Dictionary(Of String, String)

            <DataMember(Order:=5)>
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class
    End Namespace
End Namespace

VB.NET FindAnalysisRequest DTOs

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

HTTP + OTHER

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: text/jsonl

HTTP/1.1 200 OK
Content-Type: text/jsonl
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"}}}