April 2025
Highlights
The April release introduces updates to the Admin Data, Exchange Data, Import, and Risk Data APIs.
- The Admin Data API now supports the management of archives stored in Data Vault.
- The Exchange Data API adds enhanced support for managing share requests.
- The Import API now supports importing exposure variations in bulk and importing programs.
- The Risk Data API adds a new operation that returns key event statistics.
Admin Data API
Search Securables
The Search Securables operation (GET
/platform/admindata/v1/securables
) returns a filtered list of securables.
A securable is a logical container of data that is owned by a user group or principal. The owner of a securable has exclusive access to that securable and all child data. For example, the owner of an exposure set controls access to the exposures, analysis results, and variations in that exposure set.
Client applications can now define query parameters that filter securables depending on whether they have or have not been assigned to a group. The IS
and IS NOT
identity operators can be used to evaluate the groupId
against a value of NULL
.
/platform/admindata/v1/securables?offset=50&filter=groupId IS NOT NULL
/platform/admindata/v1/securables?offset=50&filter=groupId IS NULL
/platform/admindata/v1/securables?filter=securableId=20740695 AND groupId IS NOT NULL
The IS
and IS NOT
identity operators can be used with the groupId
property only:
Property | Type | Comparison | IN | Identity |
---|---|---|---|---|
groupId | string | = | IN | IS , IS NOT |
owner | string | = | IN | |
ownerStatus | string | = | ||
securableId | number | = | IN | |
securableName | string | = , LIKE | IN | |
securableType | string | = | IN |
Search Archives
The Search Archives (GET
/platform/admindata/v1/archives/{archiveId}
) and Get Archive operations now return additional information about archived databases including including sourceTypeId
, sourceType
, storageTypeId
, storageType
, and tagIds
.
An archive is a copy of a database that is stored in the Intelligent Risk Platform Data Vault. Archived databases may be stored as permanent archives or temporary archives. Client applications assigned the Data Admin role can use Admin Data API operations to create, manage, and restore archived databases.
These operations now return details about the archive.
[
{
"archiveName": "archive-of-edm",
"archiveId": 5555,
"createdAt": "2024-04-10T20:45:28.775Z",
"createdBy": "[email protected]",
"databaseType": "EDM",
"expiresAt": "string",
"exposureSetGuid": "23577b11-e018-4231-a93a-4bf46b05b910",
"exposureSetId": 27270631,
"exposureSetName": "ABC",
"serverType": "platform",
"serverName": "sql-instance-1",
"sizeInMb": 1833,
"sourceTypeId": 3,
"sourceType": "Archive Database",
"storageTypeId": 0,
"storageType": "Temporary",
"tags": [52, 53]
}
]
Property | Type | Description |
---|---|---|
sourceTypeId | Number | Data source of archive. One of 1 (Deleted Database), 2 (Snapshot Database), 3 (Archive Database). |
storageTypeId | Number | Type of archive. One of temporary (0 ) or permanent (1 ). If 0 archive is deleted on expiresDate . By default, 0 . |
storageType | String | Type of archive. One of temporary or permanent. If temporary, archive is deleted on expiratesDate . |
expiresDate | String | Date on which a temporary archive is deleted. |
tags | Array | List of tags applied to database. A tag is a label that can be applied to risk data entities that enable you to group and track related entities more efficiently. |
Update Archives
The new Update Archive operation ( PATCH
/platform/admindata/v1/archives/{archiveId}
) updates the status of the specified archive.
An archive is a copy of a database that has been deleted from a server instance. Whenever a database is deleted from a managed SQL Server instance, Intelligent Risk Platform automatically stores an archive of that database for up to 90 days.
The request takes two parameters in the request body:
{
"storageType": "permanant",
"expirationDate": "2030-12-31T00:00:00.000Z"
}
Both parameters are required.
Parameter | Type | Description |
---|---|---|
storageType | String | If permanent , the specified expirationDate value is ignored. |
expirationDate | String | Expiration date in 8601 format, e.g. 2020-01-01T00:00:00.000Z . |
This operation requires the RI-DATAVAULT
entitlement. Data Vault is a separately licensed application that enables Intelligent Risk Platform tenants to manage archives of data servers and databases.
The Get Snapshot Database operation (GET
/platform/admindata/v1/snapshots/{snapshotId}
) returns the specified database snapshot.
A snapshot is a read-only, static version of a data server. Intelligent Risk Platform takes periodic snapshots of Intelligent Risk Platform server instances. The databases on these server snapshots are called database snapshots.
This operation returns the snapshotId
, serverName
, snapshotDatabaseId
, and archiveId
.
To perform this operation, the client application must belong to a group that has been assigned RI-DATAVAULT
entitlement.
-->
Search Snapshots
The Search Snapshots operation (GET
/platform/admindata/v1/databasesnapshots
) returns list of snapshot databases.
A snapshot is a read-only, static version of a database. Intelligent Risk Platform takes periodic snapshots of Intelligent Risk Platform and Data Bridge exposure databases. Intelligent Risk Platform data administrators can recover EDM databases from the previous three days.
This operation supports response filtering based the value of a subset of properties. Depending on the property, you may use a combination of comparison operators, list operators, and logical operators.
For each snapshot, the response returns including the snaphotId
, owner
, and sizeInMb
:
[
{
"snapshotId": 5,
"snapshotDatabaseId": 211876,
"databaseName": "myDatabase",
"serverType": "databridge",
"serverName": "databridge-server-2",
"owner": "[email protected]",
"databaseType": "Edm",
"exposureSetId": 1234,
"exposureSetName": "exposure-set-123",
"exposureName": "edm-1",
"createdAt": "2024-04-10T18:11:47.185Z",
"createdBy": "[email protected]",
"sizeInMb": 19,
},
...
]
Returns an array of object. Each object contains information about a single snapshot.
Property | Type | Description |
---|---|---|
snapshot | bigint | System-defined ID of the snapshot |
databaseName | string | Name of database. |
serverType | string | Type of server. One of databridge |
serverName | string | Name of server. |
owner | string | Login that owns the database. |
databaseType | string | Type of database. One of EDM , RDM , UNKNOWN |
exposureSetId | long | ID of exposure set. Returned only if the database is registered. |
exposureSetName | string | Name of exposure set. Returned only if the database is registered. |
exposureName | string | Name of exposure. Returned only if the database is registered. |
createdAt | string | Date that snapshot was created, e.g. 2024-04-10T18:11:47.185Z |
createdBy | string | Login that created the snapshot, e.g. [email protected] |
sizeInMb | number | Size of snapshot in MB. |
Search Database Snapshot by Snapshot
The Search Database Snapshot by Snapshot operation (GET
/platform/admindata/v1/snapshots/{snapshotId}/databasesnapshots
) returns a filtered list of database snapshots on the specified server snapshot.
A snapshot is a read-only, static version of a database. Intelligent Risk Platform takes periodic snapshots of Intelligent Risk Platform and Data Bridge exposure databases. Intelligent Risk Platform data administrators can recover EDM databases from the previous three days.
This operation supports response filtering based the value of a subset of properties. Depending on the property, you may use a combination of comparison operators, list operators, and logical operators.
To perform this operation, the client application must belong to a group that has been assigned RI-DATAVAULT
entitlement.
Get Database by Snapshot
The Get Database by Snapshot operation (GET
/platform/admindata/v1/snapshots/{snapshotId}/snapshotdatabases/{snapshotdatabaseId}
) returns a database snapshot on the specified server snapshot.
To perform this operation, the client application must belong to a group that has been assigned RI-DATAVAULT
entitlement.
Create Archive from Snapshot
The Create Archive from Snapshot operation (POST
/platform/admindata/v1/snapshots/{snapshotId}/copy-to-archive
) creates an archive from the specified server snapshot.
An archive is a copy of a database that is stored in the Intelligent Risk Platform Data Vault. Archives created using this operation are assigned the Snapshot Database
source type and permanent
storage type. As a permanent archive, no expiration date is assigned and the archive persists until manually deleted.
This operation enables the client to create snapshots of all databases on the specified server snapshot:
{
"copyAllDatabaseSnapshots": true,
"expirationDate": "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'"
}
Client applications assigned the Data Admin role can use Admin Data API operations to create, manage, and restore archived databases.
If successful, adds a COPY_TO_ARCHIVE
job the workflow engine queue and returns 202 Accepted
HTTP response. Use the Get Admin Data Job operation to poll the status of this job. When the status
of the job is FINISHED
, the admin data job is complete and an archive of the database is stored in the Intelligent Risk Platform archive.
A tenant may archive a maximum of 500 databases per day and a maximum of 3,000 databases per month.
Get Admin Data Job
The Get Admin Data Job operation returns information about the specified admin data job including the status priority of the job.
When the status
of the job is FINISHED
, the admin data job is complete and an archive of the database is stored in the Intelligent Risk Platform archive.
Exchange Data API
Create Share Request
The Create Share Request operation ( POST
/platform/exchangedata/v1/sharekeys/{shareKey} /sharerequests
) now creates share requests that share multiple exposures or analysis results.
A share request is a request to make exposure or analysis data available to a recipient. Every share request is identified by a share key, which enables a specific recipient to access the data.
This operation now accepts a resourceMap
parameter that maps shared exposures and analyses. This mapping enables the client application to identify analyses that are based upon particular exposures.
{
"shareRequestName": "group share",
"recipientShareKey": "HS6FOPYSRP",
"recipientEmail": "",
"comment": "",
"resources": [
{
"resourceType": "EXPOSURE",
"resourceUris": [
"/platform/riskdata/v1/exposures/13694811",
"/platform/riskdata/v1/exposures/13693834",
"/platform/riskdata/v1/exposures/55555" //This exposure does not have any Analysis associated with it
]
},
{
"resourceType": "ANALYSIS",
"resourceUris": [
"/platform/riskdata/v1/analyses/16931626",
"/platform/riskdata/v1/analyses/16932326",
"/platform/riskdata/v1/analyses/12345",
"/platform/riskdata/v1/analyses/1111" //Analysis 1111 is not associated with any Exposure
],
"resourceMap": [
{
"exposureId": 13694811,
"analysisIds": [
16931626, //Associated with exposureId = 13694811
16932326
]
},
{
"exposureId": 13693834,
"analysisIds": [
12345 //Associated with exposureId = 13693834
]
}
]
}
]
}
The resourceMap
defines an array of objects that map analyses (specified in the ANALYSIS
resource type object) to exposures (specified in the EXPOSURES
resource type object).
Get Share Request
The Get Share Request operation (GET
/platform/exchangedata/v1/sharekeys/{shareKey}/sharerequests /sharerequest/{id}
) now returns information about mappings between shared exposures and analyses.
The resourceType
object returns additional information about the share request:
EXPOSURE
resource type objects now return theedmVersion in each
resourceProperties` object.ANALYSIS
resource type objects now return theanalysisEngineType
andanalysisFramework
properties (e.g.ELT
,PLT
) in eachresourceProperties
object.
[
{
"shareRequestId": 3468,
"shareRequestName": "group share",
"shareKey": "LDG07QLRCR",
"shareKeyName": "sharekey 2024",
"recipientShareKey": "HS6FOPYSRP",
"recipientShareKeyName": "Celtic Re",
"status": "Accepted",
"createdBy": "[email protected]",
"recipientEmail": "",
"updatedBy": "[email protected]",
"createdAt": "2025-03-20T14:50:24.639246Z",
"updatedAt": "2025-03-20T14:50:44.305511Z",
"comment": "",
"shareRequestType": "OUTBOUND",
"isPackage": true,
"resources": [
{
"resourceType": "ANALYSIS",
"resourceSize": "0 bytes",
"resourceUris": [
"/platform/riskdata/v1/analyses/16932326",
"/platform/riskdata/v1/analyses/16931626"
],
"resourceProperties": [
{
"resourceUri": "/platform/riskdata/v1/analyses/16932326",
"resourceName": "Ami_180_1",
"resourceSize": "0 bytes",
"exposureName": "dabase67",
"analysisFramework": "ELT",
"analysisType": "EP",
"analysisEngineType": "DLM",
"exposureId": 13694811
},
{
"resourceUri": "/platform/riskdata/v1/analyses/16931626",
"resourceName": "RMS_RL18_Ref_TestData_EDM_4",
"resourceSize": "0 bytes",
"exposureName": "dabase67",
"analysisFramework": "PLT",
"analysisType": "EP",
"analysisEngineType": "HD",
"exposureId": 13694811
}
]
},
{
"resourceType": "EXPOSURE",
"resourceSize": "156 MB",
"resourceUris": [
"/platform/riskdata/v1/exposures/13694811",
"/platform/riskdata/v1/exposures/13693834"
],
"resourceProperties": [
{
"resourceUri": "/platform/riskdata/v1/exposures/13694811",
"resourceName": "dabase67",
"resourceSize": "78 MB",
"edmVersion": "24"
},
{
"resourceUri": "/platform/riskdata/v1/exposures/13693834",
"resourceName": "database3",
"resourceSize": "78 MB",
"edmVersion": "24"
}
]
}
]
},
Review Share Request
The Review Share Request operation (POST
/platform/exchangedata/v1/sharekeys/{shareKey} /sharerequests/{shareRequestId}/review
)
enables a Data Exchange Admin to accept or reject both inbound and outbound share requests.
The operation now returns a resourceMap
array that includes resource type-specific information:
- If the resource type is
EXPOSURE
, each object returns theexposureId
,resourceName
, andsecurableId
. - If the resource type is
ANALYSIS
, each object may return a mapping between anexposureId
and an array ofanalysisIds
or a mapping between asecurableId
an array ofanalysisIds
.
{
"reviewType": "INBOUND_ACCEPT",
"settings": {
"comment": "accepting",
"serverId": 5308,
"securableId": 771011,
"resources": [
{
"resourceType": "EXPOSURE",
"resourceMap": [
{
"exposureId": 21321312,
"resourceName": "banana",
"securableId": 345
},
{
"exposureId": 21321313,
"resourceName": "co6okie34",
"securableId": 234
},
{
"exposureId": 21321314,
"resourceName": "blueberry",
"securableId": 123
}
]
},
{
"resourceType": "ANALYSIS",
"resourceMap": [
{
"exposureId": 13694811,
"analysisIds": [16931626, 16932326]
},
{
"analysisIds": [16931626, 16932326],
"securableId": 771034
},
{
"analysisIds": [23121, 1691231232326],
"exposureId": 1234
}
]
}
]
}
}
Import API
Create Import Job
The Create Import Job operation (POST
`/platform/import/v1/jobs
) now supports importing exposure variations in bulk into an EDM on a managed server on Data Bridge.
An exposure variation is a snapshot of an exposure. Variations enable tenants to better manage exposure data by ensuring that analyses, reports, and data exports accurately reflect the state of an exposure.
The EXPOSURE_RESOURCE
import type enables the client to import the specified exposure set into the specified EDM (exposureName
).
This operation imports the exposure data the specified EDM (exposureVariationId
) and stores it in a new database on managed server and registers that database with the specified exposureName
.
{
"importType": "EXPOSURE_RESOURCE",
"resourceUri": "/platform/riskdata/v1/exposuresets/8620364",
"settings": {
"exposureVariationId": 8633856,
"exposureName": "BM Test",
"serverId": 341213, //if this is databridge server id then accept below databaseName
"databaseName": "BM_TEST"
}
}
The request accepts the following parameters:
Parameter | Type | Description |
---|---|---|
importType | String | Description |
resourceUri | String | URI of exposure set. Exposure set must not contain an EDM. |
settings | Object | Settings for import job including exposureVariationId , exposureName , serverId , and databaseName . |
exposureVariationId | Number | ID of exposure variation. |
exposureName | String | Name of EDM. Must be unique. |
serverId | Number | ID of server. If specified serverId is that of managed server instance on Data Bridge, databaseName identifies the database. |
databaseName | String | Name of database on the specified managed server. |
If successful, this operation returns a 201
HTTP response code and initiates a IMPORT_EXPOSURE_RESOURCE_DATABRIDGE
operation.
This operation may be performed by client applications with the RI-RISKMODELER
, RI-EXPOSUREIQ
, or RI-UNDERWRITEIQ
entitlements.
Create Import Job
The Create Import Job operation (POST
/platform/import/v1/jobs
) can now import programs from an import folder.
The request package specifies the importType
, folderId
, and an array of groupIds
:
{
"importType": "PROGRAMS",
"settings": {
"folderId": "123",
"groupIds": ["group1", "group2"]
}
}
If successful, returns 202 Accepted
HTTP status response and initiates an import job that imports program data uploaded to the specified import folder.
This operation may be performed by client applications with the RI-EXPOSUREIQ
or RI-TREATYIQ
entitlements.
Get Import Job
The Get Import Job operation (GET
/platform/import/v1/jobs/{jobId}
) now returns information about PROGRAMS
import jobs.
Risk Data API
Analyses
The Search Analysis Results operation now returns the securableId
and securableType
of results in responses.
[
{
"analysisId": 18415539,
"analysisName": "TestGroup",
"createDate": "2025-03-26T23:53:20",
"description": "",
"sourceRdmName": "",
"analysisRegroupType": "Not Required",
"exposureResourceType": "PORTFOLIO",
"engineVersion": "RL24",
"groupType": "CDGP",
"cedantName": "",
"lobName": "",
"exposureResourceId": 0,
"exposureName": "",
"jobId": 33066519,
"jobGuid": "d653e063-226f-4444-a547-11ee186b604b",
"isGroup": true,
"modelProfile": {
"id": 0,
"code": "",
"name": ""
},
"outputProfile": {
"id": 0,
"code": "",
"name": ""
},
"engineType": "Group",
"analysisStatus": "Analyzed",
"analysisType": "Exceedance Probability",
"peril": "Earthquake",
"subPeril": "Shake Only",
"region": "North America",
"lossAmplification": "Building, Contents, BI",
"analysisMode": "Distributed",
"insuranceType": "Property",
"vulnerabilityCurve": "Vulnerability - Default",
"username": "[email protected]",
"eventRateSchemeNames": [],
"currency": {
"currencyName": "US Dollar",
"currencyCode": "USD",
"currencyScheme": "RMS",
"currencyAsOfDate": "2020-03-01T00:00:00Z",
"currencyVintage": "RL18"
},
"engineSubType": "Not Applicable",
"analysisFramework": "ELT",
"simulationSetId": 0,
"simulationPeriods": 0,
"exposureSetGuid": "d794da57-ed8f-4cb6-bd90-cab84c2c3071",
"uri": "/platform/riskdata/v1/analyses/18415539",
"variationId": 0,
"eventInfo": {
"eventDateBehavior": "",
"eventDate": ""
},
"entitlement": "",
"securableUri": "/platform/riskdata/v1/exposureSet/18415516",
"analysisUuid": "f4311a07-3b04-43d6-bb76-4c492ef940d0",
"appAnalysisId": 484017,
"engineId": 102,
"statusId": 102,
"typeId": 102,
"perilCode": "EQ",
"subPerilId": 1,
"regionCode": "NA",
"lossAmplificationId": 7,
"modeId": 2,
"insuranceTypeId": 1,
"vulnerabilityCurveId": 0,
"engineSubTypeCode": "NA",
"isMultiEvent": false,
"engineSubTypeId": 0,
"securableId": 18415516, // newly added field
"securableType": "exposureSet", // newly added field
"tagIds": []
},
...
]
This operation supports response filtering based the value of a subset of properties. Depending on the property, you may use a combination of comparison operators, list operators, and logical operators.
Property | Comparison | List | Logical |
---|---|---|---|
securableId | = , != , <= , >= , > , < | NOT IN , IN | AND , OR |
securableType | = , != , LIKE , NOT LIKE | NOT IN , IN | AND , OR |
This operation no longer supports filtering using the LIKE
or NOT LIKE
list operators on queries based on the exposureSetGuid
property.
Property | Comparison | List | Logical |
---|---|---|---|
exposureSetGuid | = , != | NOT IN , IN | AND , OR |
To learn more, see Filtering Responses.
The Search Analysis Results operation now returns the securableId
and securableType
of results in responses.
{
"analysisId": 12297302,
"analysisName": "TestGroup",
"createDate": "2025-02-27T22:17:23",
"description": "",
"sourceRdmName": "",
"analysisRegroupType": "Not Required",
"exposureResourceType": "PORTFOLIO",
"engineVersion": "RL24",
"groupType": "CDGP",
"cedantName": "",
"lobName": "",
"exposureResourceId": 0,
"exposureName": "",
"jobId": 32114267,
"jobGuid": "b6e7fd0b-b5d6-49bc-af7a-d332a5a9405e",
"isGroup": true,
"modelProfile": {
"id": 0,
"code": "",
"name": ""
},
"outputProfile": {
"id": 0,
"code": "",
"name": ""
},
"engineType": "Group",
"analysisStatus": "Analyzed",
"analysisType": "Exceedance Probability",
"peril": "Multi-Peril",
"subPeril": "Multi-SubPeril",
"region": "Multiple regions",
"lossAmplification": "Mixed",
"analysisMode": "Distributed",
"insuranceType": "Property",
"vulnerabilityCurve": "Vulnerability - Default",
"username": "[email protected]",
"eventRateSchemeNames": [],
"currency": {
"currencyName": "US Dollar",
"currencyCode": "USD",
"currencyScheme": "RMS",
"currencyAsOfDate": "2020-03-01T00:00:00Z",
"currencyVintage": "RL18"
},
"engineSubType": "Not Applicable",
"analysisFramework": "ELT",
"simulationSetId": 0,
"simulationPeriods": 0,
"exposureSetGuid": "c30f5307-f74d-4486-81ff-3b4d70c94669",
"uri": "/platform/riskdata/v1/analyses/12297302",
"additionalProperties": [
{
"key": "groupedAnalysisIds",
"properties": [
{
"id": 337083,
"name": "ABC Commercial",
"value": ""
},
{
"id": 337084,
"name": "ABC Commercial",
"value": ""
},
{
"id": 337085,
"name": "ABC Commercial",
"value": ""
},
{
"id": 337086,
"name": "ABC Commercial",
"value": ""
},
{
"id": 337087,
"name": "ABC Commercial",
"value": ""
},
{
"id": 337088,
"name": "ABC Commercial",
"value": ""
}
]
},
{
"key": "propagateDetailedOutput",
"properties": [
{
"id": 0,
"name": "",
"value": "Yes"
}
]
},
{
"key": "eventRateSchemes",
"properties": [
{
"id": 0,
"name": "",
"value": {
"regionCode": "CB",
"perilCode": "EQ",
"framework": "ELT",
"eventRateSchemeId": 62,
"eventRateSchemeName": "RMS Stochastic Event Rates",
"simulationSetId": 0,
"simulationSetName": "",
"simulationPeriods": 0
}
},
{
"id": 0,
"name": "",
"value": {
"regionCode": "NA",
"perilCode": "WS",
"framework": "ELT",
"eventRateSchemeId": 578,
"eventRateSchemeName": "RMS 2023 Stochastic Event Rates",
"simulationSetId": 0,
"simulationSetName": "",
"simulationPeriods": 0
}
},
{
"id": 0,
"name": "",
"value": {
"regionCode": "NA",
"perilCode": "EQ",
"framework": "ELT",
"eventRateSchemeId": 163,
"eventRateSchemeName": "RMS 17.0 NA Stochastic Event Rates",
"simulationSetId": 0,
"simulationSetName": "",
"simulationPeriods": 0
}
},
{
"id": 0,
"name": "",
"value": {
"regionCode": "GU",
"perilCode": "EQ",
"framework": "ELT",
"eventRateSchemeId": 64,
"eventRateSchemeName": "RMS Stochastic Event Rates",
"simulationSetId": 0,
"simulationSetName": "",
"simulationPeriods": 0
}
},
{
"id": 0,
"name": "",
"value": {
"regionCode": "IL",
"perilCode": "EQ",
"framework": "ELT",
"eventRateSchemeId": 66,
"eventRateSchemeName": "RMS Stochastic Event Rates",
"simulationSetId": 0,
"simulationSetName": "",
"simulationPeriods": 0
}
}
]
}
],
"variationId": 0,
"eventInfo": {
"eventDateBehavior": "",
"eventDate": ""
},
"entitlement": "",
"securableUri": "/platform/riskdata/v1/exposureSet/12297282",
"analysisUuid": "8abc1bbf-c7de-4389-9544-74461d6e827d",
"appAnalysisId": 337095,
"engineId": 102,
"statusId": 102,
"typeId": 102,
"perilCode": "YY",
"subPerilId": -1,
"regionCode": "YY",
"lossAmplificationId": 268435456,
"modeId": 2,
"insuranceTypeId": 1,
"vulnerabilityCurveId": 0,
"engineSubTypeCode": "NA",
"isMultiEvent": false,
"engineSubTypeId": 0,
"securableId": 12297282, // newly added field
"securableType": "exposureSet", // newly added field
"tagIds": []
}]
Non-EP Statistics with Key Events
The Get Non-EP statistics with Key Events operation (GET
/platform/riskdata/v1/analyses/{analysisId}/key-event-stats
) returns event-level non-EP statistics for the specified terrorism scenario analysis result.
The required analysisId
path parameter identifies the ID of a non-EP analysis computed using the Terrorism Scenario Model (TSM) for deterministic analysis. The model profile used to compute the analysis must specify of these three analysis types: Scenario
, Terrorism - Simple Footprint
, Spider-SDF
.
The Terrorism Scenario Model (TSM) provides a deterministic approach to quantify loss from a range of potential attack modes, including conventional weapons (e.g., bomb, conflagration, aircraft impact) and chemical, biological, radiological, and nuclear (CBRN) attacks. TSM can be used to overlay an attack footprint on any geographic location worldwide to quantify losses to a portfolio, and takes into account the exposure as well as the vulnerability of the locations impacted by an attack.
Limitation
This operation is supported for analysis results based on the Terrorism Scenario Model (TSM) only. If the
analysisResultId
path parameter references an analysis result computed using any other model, the response returns an HTTP400 Bad Request
client error response.
The response returns information about analyses matching the specified parameters:
[
{
"eventId": 2864907,
"stdDev": 1663.1549792686967,
"meanLoss": 0,
"cv": 6.62779067641994,
"targetId": 213,
"eventName": "string",
"latitude": "string",
"longitude": "string",
"eventType": "string",
"peril": "string",
"region": "string",
"methodOfAttackId": 23,
"radius": 21,
"radiusUnit": "string",
"countryScheme": "string",
"countryCode": "string",
"admin1Code": "string",
"admin1Name": "string",
"admin2Code": "string",
"admin2Name": "string",
"cityName": "string",
"postalCode": "string"
}
]
Exposures
Search EDMs
The Search EDMs operation no longer supports the LIKE
or NOT LIKE
list operators in queries of the exposureSetId
property.
This operation now supports the following operators:
Property | Data Type | Comparison | List |
---|---|---|---|
exposureSetId | Number | = , != , > , < , >= , <= | IN , NOT IN |
The AND
and OR
logical operators can be used to define compound queries. To learn more, see Filtering Responses.
Archive EDM
The Archive EDM operation (POST
/platform/risdata/v1/exposures/{exposureId}/archive
) creates an archive of the specified EDM (exposureId
).
An archive is a copy of a database that is saved to Data Vault. Intelligent Risk Platform supports three archive source types (Deleted Database, Snapshot Database, and Archive Database) and two archive storage types (temporary and permanent).
This operation creates a archive of the the Archive Database source type that has either a permanent or temporary storage type. The request body accepts an optional expirationDate
parameter. If specified, the archive is temporary, and will be deleted on the specified expiration date.
{
"expirationDate" : "2030-12-31T00:00:00.000Z"
}
The expiration date is specified in 8601 format, e.g. 2020-01-01T00:00:00.000Z
.
If successful, returns 202 Accepted
HTTP response code, and initiates an ARCHIVE_EDM
job.
This operation requires the RI-DATAVAULT
entitlement. Data Vault is a separately licensed application that enables Intelligent Risk Platform tenants to manage archives of data servers and databases.
Exposure Variations
The Search Exposure Variations and Get Exposure Variation operations now return the total insurable value (tiv
) of exposure variations.
The total insurable value is the sum of the insurable value across all location coverage values. For building and contents coverage, value equals replacement cost. For business interruption coverage, it equals value at one year of income. If the values differ by coverage, the TIV uses the highest value.
Programs
The Get Programs operation (GET
/platform/riskdata/v1/programs/{programId}
) now returns metadata about the treaties applied to a program.
The metadata
array returns a list of metadata objects that return the UUID
and value
of a treaty.
{
"uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"programId": 677,
...
"treaties": [
"treatyUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"treatyName": "string",
"treatyNumber": "string",
...
"metadata": [
{
"uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"value": "string"
}
]
]
}
Risk Data Jobs
The Search Risk Data Jobs operation (GET
/platform/riskdata/v1/jobs
) and Get Risk Data Job operation (GET
/platform/riskdata/v1/jobs/{jobId}
) now return information about ARCHIVE
jobs.
{
"id": 21333196,
"userName": "[email protected]",
"status": "FINISHED",
"submitTime": "2025-03-17T06:59:21.999Z",
"startTime": "2025-03-17T06:59:24Z",
"endTime": "2025-03-17T07:00:35Z",
"name": "MVS_Test_EDM_BSq20231116092706",
"type": "ARCHIVE_EDM",
"progress": 100,
"priority": "medium",
"entitlement": "RI-RISKMODELER",
"resourceGroupId": "ba672cd9-3384-4cb3-9882-bbeb5f8478c6",
"jobs": [
{
"id": "afb83d8c-ca66-47a3-965e-e94ffeb26da5",
"taskId": 1,
"workflowId": 21333196,
"status": "Succeeded",
"submitTime": "2025-03-17T06:59:24.772Z",
"createdAt": "2025-03-17T06:59:21.995Z",
"name": "ARCHIVE_EDM",
"input": {
"name": "ARCHIVE_EDM"
},
"output": {
"databaseName": "MVS_Test_EDM_BSq20231116092706"
},
"percentComplete": 100,
"continueOnFailure": false
}
],
"summary": {
"databaseName": "MVS_Test_EDM_BSq20231116092706"
}
}
Data Vault
The Admin Data API introduces support for Intelligent Risk Platform Data Vault. Data Vault is a separately licensed feature that allows data administrators to manage and restore archived databases.
An archive is a copy of a database that is stored in the Data Vault. Intelligent Risk Platform supports three archive source types (Deleted Database, Snapshot Database, and Archive Database) and two archive storage types (temporary and permanent). The source type identifies the method used to create the archive. The storage type determines whether the archive is deleted on its expiration date.
Client applications assigned the Data Admin role can use Admin Data API operations to create, manage, and restore archived databases. To perform these operations, the client application must belong to a group that has been assigned the Data Admin role and the RI-DATAVAULT entitlement. To learn more, see Access Controls.
System Usage API
The System Usage API reports Intelligent Risk Platform usage for the Archive storage Recycle Hub storage.
The SML API is not a public Platform API and not documented in the Moody's Insurance Solutions Developer Portal. The Intelligent Risk Platform uses this API to report Data Vault usage.
The /sml/usage/v1/applications/platform/data/Resources/ArchiveSizeInGb/MetricSeries
endpoint reports archive usage for Data Vault-entitled clients:
{
"values": {
"Data Vault Archives": [
[1737936000000.0, 22.6806640625],
[1738022400000.0, 22.6513671875],
[1738108800000.0, 22.6513671875],
[1738195200000.0, 22.6513671875]
]
}
}
The /sml/usage/v1/applications/platform/data/Resources/RecycleHubSizeInGb/MetricSeries
endpoint archive storage metrics for Data Vault-entitled clients within a date range:
{
"values": {
"RecycleHub": [
[1737936000000.0, 22.6806640625],
[1738022400000.0, 22.6513671875],
[1738108800000.0, 22.6513671875],
[1738195200000.0, 22.6513671875]
]
}
}