Calculate marginal impact report

post

https://{host}/riskmodeler/v1/analyses/{id}/marginal-impact

Path Params

int32

required

≥ 1

ID number of a portfolio-level reference analysis.

Body Params

marginalImpactAnalysisIds

array of int32s

length between 1 and 1

ID of an account-level analysis result. Only one ID is supported in current release.

marginalImpactAnalysisIds

currency

object

required

outputType

string

enum

required

Granularity of the report. If Account, the report returns projected losses for all policies and locations grouped by peril. If Policy the report returns projected losses for all analyses grouped by policy.

Allowed:

jobName

string

required

length between 1 and 64

^\w((?!--)[\w\s:-])*\w$|^\w*$

Unique name for the job.

rateSchemes

array of objects

Array of event rate scheme IDs to be used in metric calculations. If specified, overrides the event rate schemes used in the original analysis results.

rateSchemes

settings

object

Optional configuration of PLT-based marginal impact.

If omitted, the job returns STANDARD metrics by default.

Responses

Language

Credentials

URL

Loading…

Response

Choose an example:

*/*

application/json

202Accepted: A MARGINAL_IMPACT 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.

400Bad Request: Please check that you are provided all required values.

403Forbidden: Access to this resource is denied or not authorized to perform the "Marginal Impact" action.