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
FindAnalysisRequest Parameters:
NameParameterData TypeRequiredDescription
IdsqueryintegerNoThe Ids of the Analyses
NamequerystringNoThe partial name of the analyses
StandardEnabledquerybooleanNoFilter only Standard analysis type
RunOffEnabledquerybooleanNoFilter only Run Off analysis type
PerspectiveIdqueryintegerNoThe perspective id used for the analysis
CreatedByquerystringNoThe partial name of the user who run the analysis
AnalysisRunFromDateTimequerystringNoThe analysis run date to filter from
AnalysisRunToDateTimequerystringNoThe analysis run date to filter to
ProcessingStatusqueryintegerNoThe status of the analysis. 1 = Processing, 10 = Failed, 20 = Successful
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
Analysis Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
NameformstringNo
ModelAsOfDateformDateTime?No
PerspectiveIdformintNo
ConfigurationsformList<AnalysisConfiguration>No
DealsformList<AnalysisDeal>No
EventIdFiltersformList<AnalysisEventIdFilter>No
CreatedByformstringNo
CreatedDateUtcformDateTimeNo
CompletedDateUtcformDateTime?No
LegacyAnalysisIdformlong?No
ResultPersistenceTrackingformList<MessageTracking>No
ProcessingStatusformProcessingStatusNo
SaveResultsformboolNo
EventSourceSystemformstringNo
UpdatedDateUtcformDateTimeNo
IsExpiredformboolNo
RowIdentifierformGuidNo
ErrorMessageformstringNo
IgnoreSimulationCountMismatchformbooleanNoTake the minimum simulation count when we have different simulations between event sets
FinalStatusformProcessingStatusNo
AnalysisConfiguration Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
AnalysisIdformlongNo
WindowStartDateformDateTime?No
WindowEndDateformDateTime?No
StandardEnabledformboolNo
RunOffEnabledformboolNo
AggregateEnabledformboolNo
OccurrenceEnabledformboolNo
NettEnabledformboolNo
GrossEnabledformboolNo
TailIntensityPercentageStartformdecimal?No
TailIntensityPercentageEndformdecimal?No
MetaRiskIdformintNo
OutputLevelformResultOutputLevelNo
ProcessingStatusformProcessingStatusNo
EventLossFloorStartRangeformdecimal?No
EventLossFloorEndRangeformdecimal?No
AnalysisPortfolioEventSetConfigurationsformList<AnalysisPortfolioEventSetConfiguration>No
RowIdentifierformGuidNo
ResultOutputLevel Enum:
NotSet
PortfolioMetrics
Curve
YLT
TailIntensity
DealYlt
DealElt
DealEltWithIndustryLoss
PortfolioElt
PortfolioEltWithIndustryLoss
EventSetGeneration
PortfolioRaps
DealRaps
PortfolioSepyIndustryLoss
DealSepyIndustryLoss
ProcessingStatus Enum:
NameValue
New0
Processing1
Failed10
Successful20
AnalysisPortfolioEventSetConfiguration Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
AnalysisIdformlongNo
AnalysisConfigurationIdformlongNo
PortfolioNameformstringNo
ModelIdformstringNo
RowIdentifierformGuidNo
AnalysisDeal Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
AnalysisIdformlongNo
SourceDealIdformstringNo
DealRefformstringNo
SourceDealSystemformstringNo
EventSetIdformlongNo
ROLformdoubleNo
LimitformdoubleNo
InceptionDateformDateTimeNo
ExpiryDateformDateTimeNo
TransactionTypeformTransactionTypeNo
AllocationsformList<AnalysisPortfolioAllocation>No
PerspectiveIdOverrideformint?No
EventSetIdOverrideformlong?No
ModelAsOfDateOverrideformDateTime?No
SourceModelSystemOverrideformstringNo
SourceModelIdOverrideformstringNo
SourceEventSetIdOverrideformstringNo
EventSourceSystemOverrideformstringNo
RowIdentifierformGuidNo
TransactionType Enum:
NotSet
S
B
AnalysisPortfolioAllocation Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
AnalysisDealIdformlongNo
PortfolioNameformstringYes
AllocationPercentageformdoubleNo
RowIdentifierformGuidNo
AnalysisEventIdFilter Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
AnalysisIdformlongNo
EventSourceIdformintNo
EventIdformlongNo
RowIdentifierformGuidNo
MessageTracking Parameters:
NameParameterData TypeRequiredDescription
IdformGuidNo
AnalysisIdformlong?No
ProcessingStatusformProcessingStatusNo
MessageTypeformMessageTypeNo
CreatedDateUtcformDateTimeNo
UpdatedDateUtcformDateTimeNo
MessageType Enum:
NotSet
Persistence
Archival
QueryResponse<T> Parameters:
NameParameterData TypeRequiredDescription
OffsetformintNo
TotalformintNo
ResultsformList<Analysis>No
MetaformDictionary<string, string>No
ResponseStatusformResponseStatusNo

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"}}}