Overview
The Legacy API is a collection of API operations for managing Intelligent Risk Platform domain reference data.
Domain reference data is reference data that defines the range of possible definitions for platform resources. Reference data includes lookup data, configuration data for cat modeling analysis, and currency schemes.
Unlike other APIs, these operations can be used in coordinate with both Platform APIs and the Risk Modeler API.
The Legacy API consists of the following collections:
- ALM Profiles
- Model Profiles
- Output Profiles
- Event Rate Schemes
- Currency Schemes
Entitlements
Client applications must be assigned one of the following entitlements to use the Legacy API:
RI-RISKMODELERRI-UNDERWRITEIQ
To learn more, see Entitlements
ALM Profiles
The ALM Profiles collection exposes operations for managing ALM profiles.
An ALM profile is a pre-compiled database of loss ratio estimates and associated variances for a specific peril for one line of business at a certain geographic resolution. The ALM profile incorporates a set of assumptions regarding policy structures, geographic distributions, construction inventories, and insurance coverage type.
This collection exposes the following operations:
| Operation | Method | Path | Description |
|---|---|---|---|
| Search ALM Profiles | GET | /analysis-settings/almprofiles | Returns list of ALM profiles. |
Model Profiles
The Model Profiles collection exposes operation for managing model profiles.
A model profile is a collection of configurations that are used to analyze exposures. Model profiles may specify perils, regions, and model versions, as well as model-specific settings, such as sub-perils and post loss amplification.
This collection exposes the following operations:
| Operation | Method | Path | Description |
|---|---|---|---|
| Search Model Profiles | GET | /analysis-settings/modelprofiles | Returns list of model profiles |
| Create Model Profile | POST | /analysis-settings/modelprofiles | Creates model profile. |
| Delete Model Profile | DELETE | /analysis-settings/modelprofiles | Deletes model profile. |
| Get Model Profile | GET | /analysis-settings/modelprofiles/modelProfileId | Returns model profile. |
| Update Model Profile | PUT | /analysis-settings/modelprofiles/modelProfileId | Updates model profile. |
Output Profiles
The Output Profiles collection exposes operation for managing output profiles.
An output profile is a configuration that identifies the loss tables, EP metrics, and statistics output to an analysis result.
This collection exposes the following operations:
| Operation | Method | Path | Description |
|---|---|---|---|
| Search Output Profiles | GET | /analysis-settings/outputprofiles | Returns list of output profiles |
| Create Output Profile | POST | /analysis-settings/outputprofiles | Creates output profile |
| Delete Output Profiles | DELETE | /analysis-settings/outputprofiles | Deletes output profile |
| Get Output Profile | GET | /analysis-settings/outputprofiles/outputProfileId | Returns output profile |
| Update Output Profile | PATCH | /analysis-settings/outputprofiles/outputProfileId | Updates output profile |
| Delete Output Profile | DELETE | /analysis-settings/outputprofiles/outputProfileId | Deletes output profile |
| Get Output Profile Metrics | GET | /analysis-settings/outputprofiles/commonmetrics | Returns output profile metrics |
| Get Output Profile Metadata | GET | /analysis-settings/outputprofiles/meta | Returns output profile metadata |
| Get Output Profiles Default Metrics | GET | /analysis-settings/outputprofiles/defaultmetrics | Returns output profile default metrics |
| Update Default Output Profile | PUT | /analysis-settings/outputprofiles/setdefault/outputProfileId | Updates default output profile |
Event Rate Schemes
The Event Rate Schemes collection exposes operation for managing event rate schemes.
An event rate scheme is a collection of hypothetical stochastic events that identifies a range of potential peril- and region-specific outcomes based on historical patterns. Within an event rate scheme, each event is associated with an event rate that defines the annual probability of that event occurring.
This collection exposes the following operations:
| Operation | Method | Path | Description |
|---|---|---|---|
| Search Event Rate Schemes | GET | /data-store/referencetables/eventratescheme | Returns list of event rate schemes |
| Create Event Rate Scheme from File | POST | /data-store/referencetables/eventratescheme | Creates event rate schemes |
Currency Schemes
The Currency Schemes collection exposes operation for managing currency schemes.
A currency scheme defines exchange rates between one or more currencies and an anchor currency across multiple versions.
Versions of a currency scheme (called currency scheme vintages) are defined by the effective date of the exchange rate. Each currency vintage maps one or more currencies to an exchange rate value that specifies the rate of exchange between that currency and the anchor currency.
This collection exposes the following operations:
| Operation | Method | Path | Description |
|---|---|---|---|
| Search Currency Schemes | GET | /data-store/referencetables/currencyscheme | Returns list of currency schemes |
| Upsert Currency Scheme | POST | /data-store/referencetables/currencyscheme | Adds or updates currency scheme |
| Search Currency Scheme Vintages | GET | /data-store/referencetables/currencyschemevintage | Returns list of currency scheme vintages |
| Create Currency Scheme Vintage from File | POST | /data-store/referencetables/currencyschemevintage/file | Creates currency scheme vintages |
| Search Currency Exchange Rates | GET | /data-store/referencetables/currencyExchangeRates | Returns list of currency exchange rates |
| Create Currency Exchange Rates | POST | /data-store/referencetables/currencyExchangeRates | Creates currency exchange rates |
| Download Currency Exchange Rates | GET | /data-store/referencetables/currencyExchangeRates/file | Downloads currency exchange rates |
| Search Currencies | GET | /data-store/referencetables/currencies | Returns list of currencies |
| Upsert Currencies | POST | /data-store/referencetables/currencies | Creates or updates currencies |