API Reference

Create export job

post
https://{host}/platform/export/v1/jobs/

Creates an export job.

This resource supports the definition and submission of the different types of export jobs: EDM, EXPOSURE_RESOURCE, EXPOSURE_VARIATION. LOCATION_RESULTS, RDM_DATABRIDGE, RDM, RESULTS, ROLLUP_RESULTS.

The request specifies the exportType, the resource URI of the data to be exported, and other job-specific settings.

If the request is successful, returns a 201 Created HTTP response and adds an export job of the specified job type to the queue. Use the Get Export Job operation to poll the status of the export job.

EDM

The EDM export type enables you to export exposure data (accounts, portfolios, or aggregate portfolios) from the specified EDM data module to a database artifact (BAK or MDF).

{
  "exportType": "EDM",
  "resourceType": "exposure",
  "settings": {
    "fileExtension": "BAK",
    "sqlVersion": "2019",
    "filters": {
      "exposureResourceType": "ACCOUNTS",
      "exposureResourceIds": [555, 556, 557]
    },
    "fileName": "myEDM"
  },
  "resourceUri": "/platform/riskdata/v1/exposures/5555"
}

The optional filters parameter enables you to select exposure data by exposure type and ID.

Adds a DOWNLOAD_EDM export job to the queue.

Exposure Resources

The EXPOSURE_RESOURCE export job exports a single account or portfolio exposure to a flat file in PARQUET format.

{
  "exportType": "EXPOSURE_RESOURCE",
  "resourceType": "account",
  "settings": {
    "fileExtension": "PARQUET",
    "fileName": "myFile"
  },
  "resourceUri": "/platform/riskdata/v1/exposures/23/accounts/555"
}

Adds a DOWNLOAD_EXPOSURE_RESOURCE export job to the queue.

Exposure Variations

An EXPOSURE_VARIATION export job exports an exposure variation as a downloadable Parquet file.

An exposure variation is a snapshot of an account, aggregate portfolio,or portfolio exposure. Variations enable tenants to better manage exposure data by ensuring that analyses, reports, and data exports accurately reflect the state of an exposure.

This operation supports exporting three types of exposure variations: accountVariation, aggregatePortfolioVariation, portfolioVariation.

The request specifies the exportType, the resource type, the resource URI of the exposure variation to export, and other job-specific settings. The settings object varies depending on whether the exposure variation is exported to a downloadable Parquet file, an existing EDM, or a new EDM.

{
  "exportType": "EXPOSURE_VARIATION",
  "resourceUri": "/platform/riskdata/v1/exposurevariations/3233774",
  "resourceType": "portfolioVariation",
  "settings": {
    "fileExtension": "parquet",
    "fileName": "my_variation_export_1"
  }
}

The settings object specifies the name of the file and the file format, i.e. parquet.

If successful, this operation creates a new job (DOWNLOAD_EXPOSURE_VARIATION) and returns a 201 Created HTTP Status code. The Location header parameter returns the URL of DOWNLOAD_EXPOSURE_VARIATION job that can be used to poll the status of the job, and download the file when the job is finished.

Location Results

The LOCATION_RESULTS export type enables you to export location-level analysis results to a flat file in CSV format.

{
  "exportType": "LOCATION_RESULTS",
  "resourceType": "analyses",
  "settings": {
    "fileExtension": "CSV",
    "exposureFields": ["apZone", "areaUnit", "basinName", "biZone"],
    "perspectiveCodes": ["C0", "GR"],
    "fileName": "myCsvFile"
  },
  "resourceUris": [
    "/platform/riskdata/v1/analyses/555",
    "/platform/riskdata/v1/analyses/556",
    "/platform/riskdata/v1/analyses/557"
  ]
}

The number of analysis results that can be exported in a single request depends on the entitlement assigned to the client.

  • RI-UNDERWRITEIQ: Up to 100 analysis results can be exported.
  • RI-EXPOSUREIQ or RI-MODELER: Up to 15 analysis results can be exported.

Adds a DOWNLOAD_LOCATION_RESULTS export job to the queue.

RDM

The RDM job type enables you to export analysis result data to an RDM as a database artifact (BAK or MDF).

A maximum of 100 analysis results can be exported in a single request.

{
  "exportType": "RDM",
  "resourceType": "analyses",
  "settings": {
    "fileExtension": "BAK",
    "sqlVersion": "2019",
    "rdmName": "myRDM",
    "exportHdLossesAs": "ELT"
  },
  "resourceUris": [
    "/platform/riskdata/v1/analyses/555",
    "/platform/riskdata/v1/analyses/556",
    "/platform/riskdata/v1/analyses/557",
    "/platform/riskdata/v1/analyses/558",
    "/platform/riskdata/v1/analyses/559"
  ]
}

Adds a DOWNLOAD_RDM export job to the queue.

RDM Data Bridge

The RDM_DATABRIDGE job type enables you to export analysis results to a managed RDM database on Data Bridge.

A maximum of 100 analysis results can be exported in a single request.

{
  "exportType": "RDM_DATABRIDGE",
  "resourceType": "analyses",
  "settings": {
    "fileExtension": "PARQUET",
    "rdmName": "RDM",
    "serverId": 67,
    "databaseId": 9999,
    "exportHdLossesAs": "ELT"
  },
  "resourceUris": [
    "/platform/riskdata/v1/analyses/555",
    "/platform/riskdata/v1/analyses/556",
    "/platform/riskdata/v1/analyses/557"
  ]
}

Adds a DOWNLOAD_RDM export job to the queue.

Results

The RESULTS job type supports exporting analysis result data (loss tables, EP metrics, and statistics) to a flat file in CSV or PARQUET format.

Following one or more HD, DLM, ALM analysis, you can export the metadata, EP, stats, event loss table, period loss table, hazard data, damage data, and uncertainty data as files for manipulation outside of Risk Modeler.

For treaty losses, export of catastrophe (CATA), corporate catastrophe (CORP), stop loss (STOP), and per-risk treaty losses are supported for DLM, ALM, and HD results, but export of facultative losses is available for HD results only.

A single analysis result can be exported.

{
  "exportType": "RESULTS",
  "resourceType": "analyses",
  "settings": {
    "fileExtension": "CSV",
    "additionalOutputs": ["DAMAGE", "HAZARD", "UNCERTAINTY"],
    "lossDetails": [
      {
        "metricType": "STATS",
        "outputLevels": ["Cresta"]
      }
    ],
    "nonWeightedPlt": true
  },
  "resourceUris": ["/platform/riskdata/v1/analyses/555"]
}

Table identifies analysis results can export data:

Metric TypeHD EPHD Non-EPDLM EPDLM Non-EPALM EPALM Non-EP
DAMAGEXXXXXX
EPXXX
HAZARDX
LOSS_TABLESXXXXXX
STATSXXXX
UNCERTAINTYXX

Adds a DOWNLOAD_RESULTS export job to the queue.

Rollup analysis results

The ROLLUP_RESULTS export type supports exporting rollup analysis results to a flat file in CSV or PARQUET format.

A rollup analysis computes marginal EP curves, calculates gross and net portfolio position metrics, and breakdowns by segment for each hierarchy node in the portfolio. Rollup results include loss tables, EP curves, and statistics (aal, stddev, cv ).

This operation enables the client to export EP, PLT, or STATS for the specified analysis. Within each export loss type, data can be filtered by position or "broken down".

Exported analysis data may be segmented or unsegmented.

{
  "exportType": "ROLLUP_RESULTS",
  "resourceType": "analyses",
  "settings": {
    "fileExtension": "PARQUET",
    "lossDetails": {
      "ep": {
        "includeSegmented": true,
        "includeUnSegmented": true,
        "positionTypes": ["PROGRAM", "CONTRACT_SUBJECT", "GROSS"]
      }
    }
  },
  "resourceUris": ["/platform/riskdata/v1/analyses/555"]
}

The request can export EP, STATS, or PLT data.

Data can filtered by positionType. The following position types are supported: ASSUMED, CEDED, CONTRACT, CONTRACT_ASSUMED, CONTRACT_SUBJECT, GROSS, NET, NODE, PROGRAM, RETRO_CONTRACT, and RETRO_CONTRACT_SUBJECT.

Adds a DOWNLOAD_ROLLUP_RESULTS export job to the queue.

🪰

Entitlements

RI-EXPOSUREIQ ∙ RI-RISKMODLER ∙ RI-UNDERWRITEIQ

Language
Credentials
URL