Nephila RiskStore

<back to all web services

FindAnalysisPortfolioMetrics

General
Requires Authentication
The following routes are available for this service:
GET/api/riskstore/results/portfolio-metricsSearch portfolio metric result rows by analysis result, portfolio, metric description, or simulation
FindAnalysisPortfolioMetrics Parameters:
NameParameterData TypeRequiredDescription
AnalysisResultIdqueryintegerNo
AnalysisResultIdsqueryintegerNo
PortfolioNamequerystringNo
MetaRiskIdqueryintegerNo
MetricDescriptionquerystringNo
SimulationqueryintegerNo
AnalysisTypequeryintegerNo
SimulationLossPerspectivequeryintegerNo
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
AnalysisPortfolioMetric Parameters:
NameParameterData TypeRequiredDescription
AnalysisTypeformAnalysisTypeNo
SimulationLossPerspectiveformSimulationLossPerspectiveNo
ReinsurancePremiumLossTypeformReinsurancePremiumLossTypeNo
MetricDescriptionformstringNo
PortfolioNameformstringNo
MetricformdoubleNo
MetaRiskIdformintNo
Simulationformint?No
AnalysisResultIdformlongNo
AnalysisType Enum:
NotSet
Standard
RunOff
SimulationLossPerspective Enum:
NotSet
Agg
Occ
ReinsurancePremiumLossType Enum:
NotSet
Net
Gross
QueryResponse<T> Parameters:
NameParameterData TypeRequiredDescription
OffsetformintNo
TotalformintNo
ResultsformList<Analysis>No
MetaformDictionary<string, string>No
ResponseStatusformResponseStatusNo
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
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

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/results/portfolio-metrics 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":[{"analysisType":"NotSet","simulationLossPerspective":"NotSet","reinsurancePremiumLossType":"NotSet","metricDescription":"String","portfolioName":"String","metric":0,"metaRiskId":0,"simulation":0,"analysisResultId":0}],"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"}}}