API Reference

Simulate PLT analysis

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

Generates a PLT analysis based on the specified ELT reference 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.

Moody's 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.

Headers
uuid
required
Defaults to xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

ID of resource group. To learn more, see Resource Groups

Path Params
int64
required
≥ 1

ID of analysis result on which you want to run ELT to PLT conversion workflow. Should be valid analysis ID.

Body Params
int32
≥ 1

ID of the event rate scheme to use to compute PLT.

int32
≥ 1

ID of period event quantile table (PEQT).

int64
≥ 1

Number of simulation periods to use to compute PLT.

regionPerilSettings
array of objects

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

regionPerilSettings
Responses

SIMULATE_LOSSES job has been added to the job queue for processing.

Updated over 1 year ago

Language
Credentials
URL
Response 
 Choose an example:
*/*
application/json
Updated over 1 year ago