Risk Modeler, August 31, 2022

The August 31, 2022 release of the Risk Modeler API adds support for group-level access controls to exposure sets and introduces API services that enable clients to view and update exposure set access control lists.

An exposure set is a collection of exposure data and related analysis result data that is managed by means of an access control list (ACL). The exposure set ACL specifies the groups that may access and perform operations on exposure set data.

Principals (user accounts or client applications) are included in the ACL based on group membership.

  • An exposure set is owned by one or more groups. Members of the group that owns the exposure set may access and perform operations on the data in that exposure set.
  • By default, an exposure set is owned by the group that initially created, imported, or uploaded the exposure data in the exposure set. Analysis results subsequently generated based on those exposures are added to the exposure set.
  • The Risk Modeler API enables client applications to grant or revoke group access to exposure sets using the Update exposure set service.

For detailed information on exposure sets, see the Intelligent Risk Platform Administrator Guide.

Exposure Sets API

The Get exposure sets operation (GET v1/exposuresets) returns a list of exposure sets. The service accepts the q, sort, limit, and offset query string parameter for filtering and managing lists of exposure sets. For each exposure set, the service returns its id, name, and an array of the groups associated with that exposure set.

The Get groups by exposure set operation (GET v1/exposuresets/exposureSetId/groups) returns a list of the groups assigned to an exposure set. The required exposureSetId path parameter specifies the ID number of an exposure set. The service returns an array of groups identified by name and id attributes.

The Update exposure set operation (PATCH v1/exposuresets/exposureSetId) updates an exposure set. Using this service you can update the name of an exposure set or the groups that may access that exposure set.

Data Bridge API

The Register EDM service (POST v2/data-bridge/register) now enables the client to restrict access to a registered EDM.

The request package now accepts optional share, groups, and exposureSetId request body parameters.
If the shareparameter is is true, the client must pass a value for either groups or exposureSetId, but not both. The groups parameter specifies an array of groups that may access the exposure set. If specified, the exposureSetId identifies an existing exposure set.

{
    "datasourceName": "pg_db_01_uYcG",
    "serverId": 1457098903,
    "share": "true",
    "groups": [
        "8aa67aae-ebc2-46e6-a55e-5f095210a1e5"
    ]
}

If unspecified, the share parameter is set to true and groups parameter specifies the groups assigned to the client making the call.

Datasources API

The Manage datasource service (/v2/datasources) now supports clients to share access to newly created EDMs. By default, access to exposure data is restricted to principals (users and client applications) that are members of the group that initially created or uploaded the data.

The optional share and groups body parameters may be used to share an exposure set with an array of groups.

{
  "share":"true",
  "groups":["8aa67aae-ebc2-46e6-a55e-5f095210a1e5"]
}

If unspecified, the share parameter is set to true and groups parameter specifies the groups assigned to the client making the call.

The Get EDMs service (GET [v1][v2]/datasources) now returns the exposureSetId for each tenant EDM. The exposure set ID uniquely identifies the exposure set that manages access to the exposure data stored in the data module and the analysis results data based on that exposure data.

Exports API

The Export data module service (POST [v2] /exports) now enables the client to share access to an exposure set with other groups when it exports data to a new EDM.

The request body of a ExposureExportInput job now accepts two new parameters. The optional share and groups parameters enable the client to specify a list of groups that may access the exposure set.

{
    "type": "ExposureExportInput",
    "exportType": "EDM",
    "sourceDatasource": "TEST_EXPOSURE",
    "destinationDatasource": "newexporteddb_01",
    "exposureType": "PORTFOLIO",
    "exposureIds": [
        444
    ],
    "download": false,
    "createnew": true,
    "exportOptions": {
        "exportAccounts": true,
        "exportLocations": true,
        "exportPolicies": true,
        "exportTreaties": true,
        "exportReinsuranceInfo": true,
        "exportPerilDetailsInfo": true
    },
    "exportFormat": "BAK",
    "sqlVersion": "2019",
    "share": "true",
    "groups": ["8aa67aae-ebc2-46e6-a55e-5f095210a1e5"]
}

If unspecified, the share parameter is set to true and groups parameter specifies the groups assigned to the client making the call.

When used to export a RDM as a database artifact or to a flat file (CSV or PARQUET), the Export data module service now enables the exporting of policy-level output of HD analysis results.

The loss detail lossType parameter now accepts three values: EP, LOSS_TABLES, and STATS. Previously, exporting EP and LOSS_TABLE (PLT) results was only available for account-level output.

{
  "analysisIds": [
    23389
  ],
  "lossDetails": [
    {
      "lossType": "EP",
      "outputLevels": [
        "Policy"
      ],
      "perspectives": [
        "GR",
        "GU",
        "RL"
      ]
    },
    {
      "lossType": "LOSS_TABLES",
      "outputLevels": [
        "Policy"
      ],
      "perspectives": [
        "GR",
        "GU",
        "RL"
      ]
    }
  ],
  "exportType": "RDM",
  "type": "ResultsExportInputV2",
  "exportFormat": "CSV",
  "additionalOutputs": [
    
  ]
}

File Store API

The Upload EDM service (POST [v1] /uploads/{uploadId}/edm) now enables the client to share the uploaded EDM with other groups. By default, access to an exposure set is restricted to the group that initially uploaded or created that data. The optional share and groups body parameters may be used to share an exposure set with an array of groups.

{
    "share": "true",
    "groups": [
        "8aa67aae-ebc2-46e6-a55e-5f095210a1e5"
    ]
}

The Upload RDM service (POST [v1] /uploads/{uploadId}/rdm) now enables the client to share the uploaded RDM with other groups. By default, access to an exposure set is restricted to the group that initially uploaded or created that data. The optional share, groups, and exposureSetId body parameters may be used to share an exposure set with an array of groups. If share parameter is true, the client must pass a value for either groups or exposureSetId, but not both.

{
    "uploadId": "54872482-1a83-11ed-aeda-85de30e43183",
    "rdmName": "pg_rdmBak_05",
    "share": "true",
    exposureSetId: "5f095210-a1e5-46e6-a55e-5f095210a1e5"
}

The uploaded analysis results data is added to the specified exposure set (exposureSetId) and shared with the specified groups.