Overview

After importing exposures or uploading EDMs, use the Exposure Summary to view information about your
portfolios.

An exposure summary report provides peril-specific exposure data about the exposures within a portfolio.

Complete the following steps to generate a peril-specific PDF report that you can view and download. You can generate a report for the following perils: Earthquake, Flood, Fire, Terrorism, Severe Convective Storm and Winterstorm, and Windstorm.

Step 7.1: Generate Exposure Summary Report

The Generate summary report by portfolio generates a peril-specific report that shows exposures belonging to the specified portfolio.

The portfolio is identified in the required portfolioId path parameter. The datasource query parameter specifies the name of the EDM.

curl --request POST \
     --url 'https://api-euw1.rms.com/riskmodeler/v2/portfolios/3444/summary_report?datasource=myEDM' \
     --header 'Authorization: XXXXXXXXXX' \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \

All other parameters are specified in the request body. The required perilList parameter specifies an array of perils. One or more of EQ, FL, FR, TR, WS, and WS.

Because we're trying to confirm that the uploaded exposures were imported into the EDM and associated with the correct portfolio, we can specify an array that includes all perils:

{
     "perilList": [
          "FL",
          "FR"
     ],
     "reportName": "myValidationReport"
}

On success, the operations returns a 202 Accepted response and adds a REPORT_GENERATION job to the workflow engine queue. The Location response header specifies the job ID as part of a URL that you can use to track the status of the job, e.g. https://{host}/riskmodeler/v1/workflows/9034518.

Step 7.2: Track Workflow Job Status

The Get job status operation enables you to view the status of the REPORT_GENERATION job and provides a link to completed exposure summary report when it is complete.

The workflow ID is specified in the endpoint path.

curl --location --request GET 'https://{host}/riskmodler/v1/workflows/9034518' \
--header 'Authorization: {api_key}'

If successful, the response returns a 200 status code and workflowId of the job in the Location response header. You can poll this URL operation to track the status of the workflow job. When the job has a FINISHED status, the response returns a URL from which you can download the exposure summary report in PDF format:

{
    "id": 9034518,
    "userName": "[email protected]",
    "status": "FINISHED",
    "submitTime": "2022-12-07T23:23:37.944Z",
    "startTime": "2022-12-07T23:24:07Z",
    "endTime": "2022-12-07T23:24:28Z",
    "name": "Exposure Summary Report: myEDM : 3444",
    "type": "REPORT_GENERATION",
    "jobs": [
        {
            "id": "5141e1b6-4747-4736-926b-2141f11612d8",
            "taskId": 1,
            "workflowId": 9034518,
            "status": "Succeeded",
						...

            "output": {
                "reportType": "Exposure Summary",
                "perilCodes": "FL",
                "reportId": "abf3e2c5-ae82-42e7-9acc-40c7c9422b60",
                "reportName": "myValidationReport",
                "databaseName": "MYEDM",
                "downloadLink": "https://rms-tenants-npe-eu-west-1.s3.eu-west-1.amazonaws.com/2001076/export/reports/abf3e2c5-ae82-42e7-9acc-40c7c9422b60/myValidationReport.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20221207T232428Z&X-Amz-SignedHeaders=host&X-Amz-Expires=604800&X-Amz-Credential=AKIA3CNSARQOUY6VKOVV%2F20221207%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Signature=eeb28482cbb2dba88859c3bcedce29955ae989f36bb21147b94003cedc680d8f",
                "downloadFileSize": "100.4 kB",
                "exposureType": "portfolio",
                "tenantId": "2001076",
                "exposureId": "3444",
                "datasourceName": "myEDM",
                "expirationDate": "1671060268198"
            },
            "percentComplete": 100,
            "continueOnFailure": false
        }
    ],
    "summary": {
			...
    },
    "progress": 100,
    "messages": []
}