API Reference

Analyze portfolio

post https://{host}/riskmodeler/v2/portfolios//process

Analyzes the specified portfolio. Initiates a workflow job that generates analysis results.

Clients may define global analysis settings for DLM analyses when they initiate an account or portfolio analysis workflow job. Global analysis settings define default parameters for the accounts or portfolios in an ALM or DLM analysis job.

The service accepts a globalAnalysisSettings object that defines franchiseDeductible, minLossThreshold, treatConstructionOccupancyAsUnknown, and numMaxLossEvent attributes. The workflow engine applies these settings to ALM and DLM analysis jobs:

{
  "id" : 1,
  "exposureType" : ACCOUNT,
  "edm" : "RMS EDM SAMPLE",
  "currency" : {
    "code" : "code",
    "scheme" : "scheme",
    "asOfDate" : "2021-05-05 12:14:13",
    "vintage" : "vintage"
  },
  "modelProfileId" : 1,
  "eventRateSchemeId" : 5,
  "treaties" : null,
  "jobName" : null,
  "outputProfileId" : 2,
  "globalAnalysisSettings" : {
    "franchiseDeductible" : false,
    "minLossThreshold" : 1.0,
    "treatConstructionOccupancyAsUnknown" : true,
    "numMaxLossEvent" : 1
  }
}

Although the globalAnalysisSettings object is not required, all four attributes must be defined if it is included in the request.

  • franchiseDeductible: A boolean that determines the deductible type used for all accounts or portfolios in an analysis. If true, the workflow engine uses site-level, franchise deductibles for the accounts or portfolios analyzed. If false, the workflow engine uses standard deductibles for the accounts or portfolios analyzed.
  • minLossThreshold: A number that specifies the threshold for writing losses to the event loss tables generated during analysis. Loss values beneath the specified threshold are not written to the event loss tables. By default, 1.
  • numMaxLossEvent: An integer (up to 5000) that specifies the maximum number of events to write to the loss tables in maximum credible and maximum historical analyses. By default, 1.
  • treatConstructionOccupancyAsUnknown: A boolean value that determines how the workflow engine processes the account or portfolio when it does not recognize the buildingClassScheme or occupanyTypeScheme specified in a location’s buildingAttribute or esbBuildingAttribute. If true, Intelligent Risk Platform assumes an esbBuildingClass value of RMS 0 or esbOccupancyType value of ATC 0. If false, the workflow engine does not analyze locations with unrecognized buildingClassScheme or occupanyTypeScheme values.

📷

Workflow Job

If successful, returns a 202 Accepted HTTP response and initates a workflow job on the workflow engine. To learn more, see Workflow Engine.

📷

Idemptopotent Operation

This operation supports idempotency by means of idempotency keys. To learn more, see Idempotent Requests.

Language
Credentials
URL