Nephila RiskStore

FindAnalysisPortfolioMetrics

General

The following routes are available for this service:
GET	/api/riskstore/results/portfolio-metrics	Search portfolio metric result rows by analysis result, portfolio, metric description, or simulation

**FindAnalysisPortfolioMetrics** Parameters:
Name	Parameter	Data Type	Required
AnalysisResultId	query	integer	No
AnalysisResultIds	query	integer	No
PortfolioName	query	string	No
MetaRiskId	query	integer	No
MetricDescription	query	string	No
Simulation	query	integer	No
AnalysisType	query	integer	No
SimulationLossPerspective	query	integer	No

**QueryBase** Parameters:
Name	Parameter	Data Type	Required
Skip	form	int?	No
Take	form	int?	No
OrderBy	form	string	No
OrderByDesc	form	string	No
Include	form	string	No
Fields	form	string	No
Meta	form	Dictionary<string, string>	No

**AnalysisPortfolioMetric** Parameters:
Name	Parameter	Data Type	Required
AnalysisType	form	AnalysisType	No
SimulationLossPerspective	form	SimulationLossPerspective	No
ReinsurancePremiumLossType	form	ReinsurancePremiumLossType	No
MetricDescription	form	string	No
PortfolioName	form	string	No
Metric	form	double	No
MetaRiskId	form	int	No
Simulation	form	int?	No
AnalysisResultId	form	long	No

**AnalysisType** Enum:
NotSet
Standard
RunOff

**SimulationLossPerspective** Enum:
NotSet
Agg
Occ

**ReinsurancePremiumLossType** Enum:
NotSet
Net
Gross

**QueryResponse<T>** Parameters:
Name	Parameter	Data Type	Required
Offset	form	int	No
Total	form	int	No
Results	form	List<Analysis>	No
Meta	form	Dictionary<string, string>	No
ResponseStatus	form	ResponseStatus	No

**Analysis** Parameters:
Name	Parameter	Data Type	Required	Description
Id	form	long	No
Name	form	string	No
ModelAsOfDate	form	DateTime?	No
PerspectiveId	form	int	No
Configurations	form	List<AnalysisConfiguration>	No
Deals	form	List<AnalysisDeal>	No
EventIdFilters	form	List<AnalysisEventIdFilter>	No
CreatedBy	form	string	No
CreatedDateUtc	form	DateTime	No
CompletedDateUtc	form	DateTime?	No
LegacyAnalysisId	form	long?	No
ResultPersistenceTracking	form	List<MessageTracking>	No
ProcessingStatus	form	ProcessingStatus	No
SaveResults	form	bool	No
EventSourceSystem	form	string	No
UpdatedDateUtc	form	DateTime	No
IsExpired	form	bool	No
RowIdentifier	form	Guid	No
ErrorMessage	form	string	No
IgnoreSimulationCountMismatch	form	boolean	No	Take the minimum simulation count when we have different simulations between event sets
FinalStatus	form	ProcessingStatus	No

**AnalysisConfiguration** Parameters:
Name	Parameter	Data Type	Required
Id	form	long	No
AnalysisId	form	long	No
WindowStartDate	form	DateTime?	No
WindowEndDate	form	DateTime?	No
StandardEnabled	form	bool	No
RunOffEnabled	form	bool	No
AggregateEnabled	form	bool	No
OccurrenceEnabled	form	bool	No
NettEnabled	form	bool	No
GrossEnabled	form	bool	No
TailIntensityPercentageStart	form	decimal?	No
TailIntensityPercentageEnd	form	decimal?	No
MetaRiskId	form	int	No
OutputLevel	form	ResultOutputLevel	No
ProcessingStatus	form	ProcessingStatus	No
EventLossFloorStartRange	form	decimal?	No
EventLossFloorEndRange	form	decimal?	No
AnalysisPortfolioEventSetConfigurations	form	List<AnalysisPortfolioEventSetConfiguration>	No
RowIdentifier	form	Guid	No

**ResultOutputLevel** Enum:
NotSet
PortfolioMetrics
Curve
YLT
TailIntensity
DealYlt
DealElt
DealEltWithIndustryLoss
PortfolioElt
PortfolioEltWithIndustryLoss
EventSetGeneration
PortfolioRaps
DealRaps

**ProcessingStatus** Enum:
Name	Value
New	0
Processing	1
Failed	10
Successful	20

**AnalysisPortfolioEventSetConfiguration** Parameters:
Name	Parameter	Data Type	Required
Id	form	long	No
AnalysisId	form	long	No
AnalysisConfigurationId	form	long	No
PortfolioName	form	string	No
ModelId	form	string	No
RowIdentifier	form	Guid	No

**AnalysisDeal** Parameters:
Name	Parameter	Data Type	Required
Id	form	long	No
AnalysisId	form	long	No
SourceDealId	form	string	No
DealRef	form	string	No
SourceDealSystem	form	string	No
EventSetId	form	long	No
ROL	form	double	No
Limit	form	double	No
InceptionDate	form	DateTime	No
ExpiryDate	form	DateTime	No
TransactionType	form	TransactionType	No
Allocations	form	List<AnalysisPortfolioAllocation>	No
PerspectiveIdOverride	form	int?	No
EventSetIdOverride	form	long?	No
ModelAsOfDateOverride	form	DateTime?	No
SourceModelSystemOverride	form	string	No
SourceModelIdOverride	form	string	No
SourceEventSetIdOverride	form	string	No
EventSourceSystemOverride	form	string	No
RowIdentifier	form	Guid	No

**TransactionType** Enum:
NotSet
S
B

**AnalysisPortfolioAllocation** Parameters:
Name	Parameter	Data Type	Required
Id	form	long	No
AnalysisDealId	form	long	No
PortfolioName	form	string	Yes
AllocationPercentage	form	double	No
RowIdentifier	form	Guid	No

**AnalysisEventIdFilter** Parameters:
Name	Parameter	Data Type	Required
Id	form	long	No
AnalysisId	form	long	No
EventSourceId	form	int	No
EventId	form	long	No
RowIdentifier	form	Guid	No

**MessageTracking** Parameters:
Name	Parameter	Data Type	Required
Id	form	Guid	No
AnalysisId	form	long?	No
ProcessingStatus	form	ProcessingStatus	No
MessageType	form	MessageType	No
CreatedDateUtc	form	DateTime	No
UpdatedDateUtc	form	DateTime	No

**MessageType** Enum:
NotSet
Persistence
Archival

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

HTTP + JSV

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/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
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: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}