| Requires any of the roles: | Riskstore.Write, Riskstore.Admin |
| GET | /api/riskstore/analysis | Search for analyses |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Ids | query | integer | No | The Ids of the Analyses |
| Name | query | string | No | The partial name of the analyses |
| StandardEnabled | query | boolean | No | Filter only Standard analysis type |
| RunOffEnabled | query | boolean | No | Filter only Run Off analysis type |
| PerspectiveId | query | integer | No | The perspective id used for the analysis |
| CreatedBy | query | string | No | The partial name of the user who run the analysis |
| AnalysisRunFromDateTime | query | string | No | The analysis run date to filter from |
| AnalysisRunToDateTime | query | string | No | The analysis run date to filter to |
| ProcessingStatus | query | integer | No | The status of the analysis. 1 = Processing, 10 = Failed, 20 = Successful |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| 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 |
| 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 |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| 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 |
| NotSet | |
| PortfolioMetrics | |
| Curve | |
| YLT | |
| TailIntensity | |
| DealYlt | |
| DealElt | |
| DealEltWithIndustryLoss | |
| PortfolioElt | |
| PortfolioEltWithIndustryLoss | |
| EventSetGeneration | |
| PortfolioRaps | |
| DealRaps | |
| PortfolioSepyIndustryLoss | |
| DealSepyIndustryLoss |
| Name | Value | |
|---|---|---|
| New | 0 | |
| Processing | 1 | |
| Failed | 10 | |
| Successful | 20 |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | long | No | |
| AnalysisId | form | long | No | |
| AnalysisConfigurationId | form | long | No | |
| PortfolioName | form | string | No | |
| ModelId | form | string | No | |
| RowIdentifier | form | Guid | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| 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 |
| NotSet | |
| S | |
| B |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | long | No | |
| AnalysisDealId | form | long | No | |
| PortfolioName | form | string | Yes | |
| AllocationPercentage | form | double | No | |
| RowIdentifier | form | Guid | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | long | No | |
| AnalysisId | form | long | No | |
| EventSourceId | form | int | No | |
| EventId | form | long | No | |
| RowIdentifier | form | Guid | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | Guid | No | |
| AnalysisId | form | long? | No | |
| ProcessingStatus | form | ProcessingStatus | No | |
| MessageType | form | MessageType | No | |
| CreatedDateUtc | form | DateTime | No | |
| UpdatedDateUtc | form | DateTime | No |
| NotSet | |
| Persistence | |
| Archival |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Offset | form | int | No | |
| Total | form | int | No | |
| Results | form | List<Analysis> | No | |
| Meta | form | Dictionary<string, string> | No | |
| ResponseStatus | form | ResponseStatus | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
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/csv
HTTP/1.1 200 OK
Content-Type: text/csv
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"}}}