Resources for exporting risk data from the Intelligent Risk Platform
Overview
The Export API exposes a collection of API operations to create and run export jobs allowing the users to export the Intelligent Risk Platform resources as external files
EDMEXPOSURE_RESOURCEEXPOSURE_VARIATIONLOCATION_RESULTSRDM_DATABRIDGERDMRESULTSROLLUP_RESULTS
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).
EXPOSURE_RESOURCE
The EXPOSURE_RESOURCE export type enables you to export a single account or portfolio exposure to a flat file in PARQUET format.
EXPOSURE_VARIATION
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.
LOCATION_RESULTS
The LOCATION_RESULTS export type enables you to export location-level analysis results to a flat file in CSV format.
RDM_DATABRIDGE
The RDM_DATABRIDGE job type enables you to export analysis results to a managed RDM database on Data Bridge.
RDM
The RDM job type enables you to export analysis result data to an RDM as a database artifact (BAK or MDF).
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.
The following property values can be specified in the exposureFields array:
apZone, areaUnit, basinName, biZone, buildingClass, buildingElevation, buildingElevationMatch, buildingHeight, catchmentId, cityName, constructionClassCode, constructionClassScheme, countryRMSCode, county, distanceToCalFireHigh, distanceToCalFireMedium, distanceToCalFireVeryHigh, distanceToClosestMine, distanceToClosestSinkhole, distanceToCoast, distanceToInnerCoast, distanceToWuiInterface, distanceToWuiIntermix, dominantSubperilCS, dominantSubperilWT, dwellTime, elevationAverage, eqBiValue, eqBuildingValue, eqContentsValue, eqSiteDeductible, eqSiteLimit, estimatedEmployees, faultDistance1, faultsBackgroundRates, faultsDistance1, faultsDistance2, faultsDistance3, faultsDistance4, faultsDistance5, faultsName1, faultsName2, faultsName3, faultsName4, faultsName5, faultsReturnPeriodM601, faultsReturnPeriodM602, faultsReturnPeriodM603, faultsReturnPeriodM604, faultsReturnPeriodM605, faultsReturnPeriodM651, faultsReturnPeriodM652, faultsReturnPeriodM653, faultsReturnPeriodM654, faultsReturnPeriodM655, faultsReturnPeriodM701, faultsReturnPeriodM702, faultsReturnPeriodM703, faultsReturnPeriodM704, faultsReturnPeriodM705, fl1000YRInlandDepthUndef, fl1000YrRpDef, fl1000YrRpUndef, fl100YRInlandDepthUndef, fl100YrRpDef, fl100YrRpUndef, fl10YRInlandDepthUndef, fl200YRInlandDepthUndef, fl200YrRpDef, fl200YrRpUndef, fl250YRInlandDepthUndef, fl250YrRpDef, fl250YrRpUndef, fl30YRInlandDepthUndef, fl30YRrpDef, fl30YRrpUndef, fl500YRInlandDepthUndef, fl500YrRpDef, fl500YrRpUndef, fl50YRInlandDepthUndef, fl50YrRpDef, fl50YrRpUndef, flBiValue, flBuildingValue, flContentsValue, flSiteDeductible, flSiteLimit, flZone, floodBfe, floorArea, frBiValue, frBuildingValue, frContentsValue, frSiteDeductible, frSiteLimit, geoMatchLevel, heightUnit, histFireYearCount10km, histFireYearCount20km, histFireYearCount250m, histFireYearCount2km, histFireYearCount5km, landslide, latitude, liquefaction, locationId, locationName, locationNumber, longitude, mineArea1, mineArea2, mineArea3, mineArea4, mineArea5, mineDistance1, mineDistance2, mineDistance3, mineDistance4, mineDistance5, mineName1, mineName2, mineName3, mineName4, mineName5, mineStatus1, mineStatus2, mineStatus3, mineStatus4, mineStatus5, mineType1, mineType2, mineType3, mineType4, mineType5, mmi100, mmi1000, mmi1500, mmi200, mmi250, mmi475, mmi500, nfipRate, nfipYear, nfipYearMatch, nship, numberOfBuildings, numberOfStories, occupancyType, occupancyTypeCode, occupancyTypeScheme, otherZones, percentInGeographyCS, percentInGeographyEQ, percentInGeographyFR, percentInGeographyWS, percentInGeographyWT, postalCode, rms100Flzone, rms500Flzone, rmsBuildingElevation, rmsBuildingElevationMatch, score1CS, score1EQ, score1FL, score1FR, score1TR, score1WS, score1WT, score2CS, score2EQ, score2FL, score2WS, score2WT, score3CS, score3EQ, score3FL, score3WS, score3WT, scoreOverall3WS, scoreOverallCS, scoreOverallEQ, scoreOverallFL, scoreOverallFR, scoreOverallTR, scoreOverallWT, sinkHoleArea1, sinkHoleArea2, sinkHoleArea3, sinkHoleArea4, sinkHoleArea5, sinkHoleDistance1, sinkHoleDistance2, sinkHoleDistance3, sinkHoleDistance4, sinkHoleDistance5, sinkholeHazardZone, slopeAverage, soilType, soilTypeDescription, soilVs, stateCode, stochasticBurnProb, streetAddress, tiv, toBiValue, toBuildingValue, toContentsValue, toSiteDeductible, toSiteLimit, totalEmployees, totalPayroll, trBiValue, trBuildingValue, trContentsValue, trSiteDeductible, trSiteLimit, urbanConFlagRationScore, userid1, userid2, usertxt1, usertxt2, wildFireHazard, wildfireAreaDescription, wildfireFuelTypeDescription, wildfireSusceptibility, wildfireThreat, windpoolZone, windpoolZonePremium, ws10000YrRpSurgeDef, ws10000YrRpWind, ws1000YrRpSurgeDef, ws1000YrRpWind, ws100YrRpSurgeDef, ws100YrRpWind, ws10YrRpSurgeDef, ws10YrRpWind, ws1YrRpSurgeDef, ws1YrRpWind, ws200YrRpSurgeDef, ws200YrRpWind, ws250YrRpSurgeDef, ws250YrRpWind, ws25YrRpSurgeDef, ws25YrRpWind, ws2YrRpSurgeDef, ws2YrRpWind, ws500YrRpSurgeDef, ws500YrRpWind, ws50YrRpSurgeDef, ws50YrRpWind, ws5YrRpSurgeDef, ws5YrRpWind, wsBiValue, wsBuildingValue, wsContentsValue, wsSiteDeductible, wsSiteLimit, yearBuilt, yearLastHistFire250m, zone1, zone3Name, zone4Name
ROLLUP_RESULTS
ROLLUP_RESULTSThe ROLLUP_RESULTS export type supports exporting rollup analysis results to a flat file in CSV or PARQUET format.
Schema Version
The Export API now enables tenants to specify the schema version of exported exposure and analysis results data.
By default, the exposure data exported to an on-premise EDM database or analysis results data exported to a new RDM database is automatically exported to the latest version of schema, Version 25.
The Create Export Job operation now accepts a schemaVersion parameter that specifies the schema version of the exposure or result data exported to an EDM or RDM database.
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.