Moody’s strongly recommends that Risk Modeler and UnderwriteIQ tenants use the Platform APIs instead of the Risk Modeler APIs for all future projects. See Migrate to Plaform APIs.

API Reference

Simulate PLT analysis

post
https://{host}/riskmodeler/v1/analyses//simulate-losses

Generates a PLT analysis based on the specified ELT base analysis as a post-analysis action.

This operation recalculates projected ELT losses as PLT losses using the specified event rate scheme, simulation set, and number of simulation periods. The simulated PLT analysis returns the event ID of every event in each simulated period, and the calculated loss value of each of these events.

RMS recommends that you run the full number of simulation periods. The number of simulation periods determines the number of possible outcomes that are modeled over the calendar period in order to calculate the OEP and AEP curves. Greater numbers of periods increase the accuracy of modeled results but also increase analysis time and the size of the output data.

🍐

Permissions

To perform this operation, a principal must belong to a group that has been assigned the appropriate role-based permissions. The table identifies the roles with permission to perform this operation.

UnderwriterTechnical UnderwriterRisk AnalystPortfolio ManagerCat Modeler
NONOYESYESYES

To learn more about role-based permissions in Risk Modeler, see Groups and Roles.

Path Params
int32
required
≥ 1

ID of the base analysis.

Body Params
string
string
string
int32

ID of the event rate scheme used to calculate a PLT analysis. The PLT Engine substitutes the specified event rate scheme for the event rate scheme used in the ELT-based reference analysis.

int32
required

ID of a period event quantile table (PEQT).

string

Name of a period event quantile table (PEQT).

int64
required

Number of simulation periods used to generate the PLT.

regionPerilSettings
array of objects
required

If present, the fields eventRateSchemeId, simulationSetId, and simulationPeriods are not allowed.

regionPerilSettings*
Responses

SIMULATE_LOSSES job was added to the workflow engine queue for processing. Returns a URL in the Location header that enables you to track the status of the job e.g. /{host}/v1/workflows/100000. Send periodic HTTP GET requests to the URL for the job status. See Workflow Engine.

Updated over 2 years ago

Language
Credentials
URL
LoadingLoading…
Response
Choose an example:
*/*
application/json

Updated over 2 years ago