Export API Overview

Resources for exporting risk data from the Intelligent Risk Platform

Overview

The Export API exposes a collection of API operations to create and run jobs that export exposure and analysis result data to a variety of downloadable formats including flat files (CSV or Parquet) and database artifacts (BAK or MDF).

The API supports the following types of exports: EDM, EXPOSURE_RESOURCE, EXPOSURE_VARIATION, LOCATION_RESULTS, RDM, RDM_DATABRIDGE, RESULTS, ROLLUP_RESULTS. Each export type supports a distinct workflow. A client application's to manage these workflows depend on entitlements and role-based access controls assigned to it.

Exported data can be saved to the current (v25) or previous versions (v21, v22, v23, v24) of the EDM and RDM data schemas.

Operations

The Export API supports the following operations:

OperationEndpointDescription
Create Export JobPOST /platform/export/v1/jobsCreates an export job of a particular export type.
Search Export JobsGET /platform/export/v1/jobsReturns list of export jobs.
Get Export JobGET /platform/export/v1/jobs/{exportid}Returns specific export job.
Update Export JobPATCH /platform/export/v1/jobs/{exportid}Updates the status or priority of a specific job.

These operations enable the client to create and manage different types of export jobs.

Export Types

Every request to export data is defined by by its export type, which identifies the data to be exported (exposures or results) and file exported to:

  • The EDM and RDM export types support exporting data to downloadable database artifacts in BAK or MDF format.
  • The RDM_DATABRIDGE export type enables licensed RI-DATABRIDGE tenants to results data to new or existing RDM databases on their Data Bridge cluster.
  • The EXPOSURE_RESOURCE, EXPOSURE_VARIATION, LOCATION_RESULTS, RESULTS, and ROLLUP_RESULTS export types enable the client to export data to downloadable flat files in CSV, Parquet.

The Export API supports exporting exposure and results data in various formats:

Export TypeFile TypeDescription
EDMBAK, MDFExports exposure data to database artifact.
EXPOSURE_RESOURCEParquetExports exposure to flat file.
EXPOSURE_VARIATIONParquetExports exposure variation to flat file.
LOCATION_RESULTSCSVExports result data to flat file.
RDMBAK, MDFExports result data to database artifact.
RDM_DATABRIDGEExports result data to RDM on Data Bridge.
RESULTSCSV, ParquetExports result data to flat file.
ROLLUP_RESULTSCSV, ParquetExports rollup data to flat file.

These operations support specifying the schema version of data exported to flat files as well data exported to databases.

📷

End of SQL Server 2016 Support

Microsoft plans to end extended support of SQL Server 2016 on July 14, 2026. As a result, the Intelligent Risk Platform™ will end support for SQL Server 2016 in June 2026. This change may affect jobs created using using the EDM, RDM and RDM_DATABRIDGE export types.

Jobs

The Create Export Job operation defines and creates a job.

The exportType parameter specifies the type of export job created by the request:

Export TypeJob
EDMDOWNLOAD_EDM
EXPOSURE_RESOURCEDOWNLOAD_EXPOSURE_RESOURCE
EXPOSURE_VARIATIONDOWNLOAD_EXPOSURE_VARIATION
LOCATION_RESULTSDOWNLOAD_LOCATION_RESULTS
RDMDOWNLOAD_RDM
RDM_DATABRIDGEDOWNLOAD_RDM
RESULTSDOWNLOAD_RESULTS
ROLLUP_RESULTSDOWNLOAD_ROLLUP_RESULTS

The Search Export Job operation, which returns a list of export jobs, support reponse filtering by type. For example, the following query returns DOWNLOAD_EDM jobs only:

https://{{HOST}}/platform/export/v1/jobs?filter=type="DOWNLOAD_EDM"

The Get Export Job operation enables the client to poll the status of export jobs.

Database Schema Versions

The Export API enables to client applications to export exposure data and results data managed on the Intelligent Risk Platform to different versions of the database schema: 18, 21, 22, 23, 24, and 25.

A database schema defines the structure of a relational database including the logical constraints (tables, names data types) that define the relationship between the entities stored in the database.

The Intelligent Risk Platform manages exposure and results data based on proprietary schemas that define the database schemas used by the EDM and RDM data modules:

  • The EDM Database Schema documents the exposure data module (EDM) schema used to store detailed exposure, hazard, and financial information.
  • The RDM Database Schema documents the results data module (RDM) schema used to store results data (ALM, DLM, and HD) exported to a RDM from the Intelligent Risk Platform.

EDM and RDM schemas are versioned. As new features are added to the Intelligent Risk Platform, Moody's releases new versions of the EDM database schema and RDM database schema that support the required tables, fields, and data types.

The Intelligent Risk Platform manages data in data modules that use a proprietary schema. This database schema defines how data is organized within the data module; it defines the table names, fields, data types and the relationships between these entities. As new features are added to the Intelligent Risk Platform, Moody's releases new versions of the EDM database schema and RDM schema that support the required tables, fields, and data types.

The Create Export Job operation now accepts a schemaVersion parameter that specifies the schema version of exported exposure or result data.

The schemaVersion parameter can be specified in the body of Create Export Job requests with the EDM and RDM export types. The parameter accepts the following values: v18, v21, v22, v23, v24, v25.

The schemaVersion parameter can be specified in all export job requests:

  • EDM
  • EXPOSURE_RESOURCE
  • EXPOSURE_VARIATION
  • LOCATION_RESULTS
  • RDM_DATABRIDGE
  • RDM
  • RESULTS
  • ROLLUP_RESULTShe schemaVersion parameter can be specified in the body of Create Export Job requests with the EDM and RDM export types. The parameter accepts the following values: v18, v21, v22, v23, v24, v25.

Entitlements

The client's ability to initiate different export workflows depend on the client having the appropriate entitlement to perform that operation.

Export TypeEntitlement
EDMRI-RISKMODLER, RI-UNDERWRITEIQ
EXPOSURE_RESOURCERI-RISKMODLER, RI-UNDERWRITEIQ
EXPOSURE_VARIATIONRI-RISKMODLER, RI-UNDERWRITEIQ
LOCATION_RESULTSRI-EXPOSUREIQ, RI-RISKMODLER, RI-UNDERWRITEIQ
RDMRI-RISKMODLER, RI-UNDERWRITEIQ
RESULTSRI-RISKMODLER, RI-UNDERWRITEIQ
ROLLUP_RESULTSRI-TREATYIQ
RDM_DATABRIDGERI-EXPOSUREIQ, RI-DATABRIDGE

To learn more about entitlments, see Entitlements

Postman Collections

Moody's Insurance Solutions makes Postman Collections available for download via the RMS Developers workspace:

This website offers collections that document the following workflows based on Export API operations:

Export TypeCollection
EDM
EXPOSURE_RESOURCEExport EXPOSURE_RESOURCE
EXPOSURE_VARIATION
LOCATION_RESULTSExport LOCATION_RESULTS Export
RDMExport RDM Export
RESULTS
ROLLUP_RESULTS
RDM_DATABRIDGEExport RDM_DATABRIDGE Export