Overview

The Risk Data API exposes a collection of API operations that create, access and manage the risk resources that are the building blocks of Intelligent Risk Platform catastrophe modeling workflows.

These risk resources are generally known as exposures. Strictly speaking an exposure is an insured property, building, or other entity that is vulnerable to catastrophe risk and may produce a financial loss, i.e. a location. The term exposure is also used to identify collections of location exposures (e.g. accounts or portfolios) that are modeled collectively.

Collections

The Risk Data API consists of multiple groupings of related API operations known as collections.

The table lists Risk Data API collections.

Collection	Description
Accounts	Operations for creating, managing, and viewing accounts.
Aggregate Portfolios	Operations for creating, managing, and viewing aggregate portfolios.
Analyses	Operations for viewing and managing analysis results.
Branches	Operations for managing branches.
Business Hierarchies	Operations for managing business hierarchies.
Business Hierarchy Sets	Operations for managing business hierarchy sets.
Business Hierarchy Variations	Operations for managing business hierarchy variations.
Cedants	Operations for managing cedants.
Data Servers	Operations for managing data servers.
Databases	Operations for managing databases.
Exposure Sets	Operations for managing exposure sets.
Exposure Variations	Operations for managing exposure variations.
Exposures	Operations for managing EDMs.
HD Step Policies	Operations for managing HD step policies.
Line of Business	Operations for managing lines of business (LOBs).
Locations	Operations for managing locations, location coverage, location conditions, location cessions.
Policies	Operations for managing policies.
Policy Conditions	Operations for managing policy conditions.
Portfolios	Operations for managing portfolios.
Producers	Operations for managing producers.
Program Sets	Operations for managing program sets.
Program Variations	Operations for managing program variations.
Programs	Operations for managing programs.
Report Views	Operations for managing UnderwriteIQ report views.
Reports	Operations for managing reports.
Risk Data Jobs	Operations for managing risk data jobs.
Risk Sources	Operations for managing risk sources.
Rollup Analyses	Operations for managing TreatyIQ rollup analysis results.
Share Sets	Operations for managing share sets.
Treaties	Operations for managing treaties.
Underwriters	Operations for managing underwriters.
Utilities	Operations for managing facultative cessions.

Jobs

A job is a long-running process that consumes significant system resources (e.g. CPU, memory, I/O ). In general, API requests that cannot be returned immediately are added to the job queue for processing.

Unlike most Platform APIs, the Risk Data API operations can initiate a variety of jobs.

On success, the API returns a 201 Created or 202 Accepted HTTP status code and the resource URI of the job. This URI enables the client to poll for the status of the job. The Get Risk Data Job operation supports polling of risk data jobs.

Platform APIs support two types of jobs: model jobs and non-model jobs. A model job is a job that leverages a catastrophe model to compute risk to an exposure and produces an analysis result. Most risk data jobs are model jobs. A non-model job is any job that does not return an analysis result.

The table lists of jobs initiated by Risk Data API operations:

Job	Operation	Job Type
`ARCHIVE_EDM`	Archive EDM	Non-Model
`BULK_EDIT`	Exposure Bulk Edit	Model
`CLIMATE_CHANGE`	Calculate Climate Change	Non-Model
`CONVERT_EVENT_RATE_LOSS`	Convert Event Rates and Losses	Non-Model
`CREATE_EDM`	Create EDM	Non-Model
`DELETE_ACCOUNT`	Delete Account	Non-Model
`DELETE_AGGREGATE_PORTFOLIO`	Delete Aggregate Portfolio	Non-Model
`DEREGISTER_EDM`	Deregister EDM	Non-Model
`GEOHAZ`	Geocode Location	Non-Model
`HD_MAP_PERSPECTIVE`	Convert Financial Perspectives	Non-Model
`MAP_PERSPECTIVE`	Convert Financial Perspectives	Non-Model
`MARGINAL_IMPACT`	Calculate Marginal Impact	Non-Model
`PATE`	Recalculate with PATE	Non-Model
`PLT_TO_ELT`	Convert PLT to ELT Analysis	Non-Model
`REGISTER_DATA_BRIDGE_EDM`	Register EDM	Non-Model
`REPORT_GENERATION`	Create Risk Data Report	Non-Model
`RERUN_EP`	Recalculate EP and Statistics	Non-Model
`SIMULATE_LOSSES`	Simulate PLT Analysis	Non-Model

Postman Collections

A Postman Collection is a set of related API operations that when run in sequence perform a standard workflow. Each Postman Collection defines data structures for evaluating and testing Intelligent Risk Platform features, and understanding how request parameters affect responses.

A collection typically chains together individual requests so that values returned from operation are automatically passed to the next operation.

Moody's Insurance Solutions makes Postman Collections available to licensed tenants for download from the RMS Developers public workspace.

The table lists Postman Collections that define workflows based on Risk Data API operations:

Postman Collection	Operations	Description
Convert Event Rates & Apply Loss Adjustments	Convert Event Rates and Losses	Workflow for computing a new analysis result based on an existing portfolio-level EP result by applying event rate or event loss adjustments.
Create Exposure Set and EDM	Create Exposure Set, Create EDM	Workflow for creating an exposure set and EDM.
Portfolio Analysis Grouping	Create Grouping Job	Workflow for creating an anlaysis group.
Set Up TreatyIQ Programs	Create Program Set, Create Inward Program, Update Program, Bulk Create Risk Sources	Workflow for creating program set, program, and risk sources.