🥥

Highlights

The May release introduces enhanced reporting of Risk Data API jobs.

• The Risk Data API now supports enhanced reporting
  Learn More

Risk Data API

Reporting

The Create Risk Data Report operation (POST /platform/riskdata/v1/reports) now supports the EXPOSURE_DOI_REPORT report type.

The California DOI report (EXPOSURE_DOI_REPORT report type) measures the the financial capacity of licensed insurance companies in California.

All parameters are specified in the body of the request. The resourceUri, reportTypeandsettings` parameters are required.

If the reportType is EXPOSURE_DOI_REPORT, the resourceUri must specify an exposure in California and the perilCodes parameter must be eq:

{
  "reportType": "EXPOSURE_DOI_REPORT",
  "resourceUri": "/platform/riskdata/v1/exposures/1234/portfolios/2",
  "resourceType": "portfolio",
  "settings": {
    "perilCodes": [
      "eq"
    ],
    "fileExtension": "PDF",
    "reportName": "test_doi_report",
    "scaleFactors": [
      {
        "type": "building",
        "factor": 1.0
      },
      {
        "type": "content",
        "factor": 1.0
      },
      {
        "type": "bi",
        "factor": 1.0
      }
    ],
    "additionalDownloadOptions": {
      "rdmDatabridge": {
          "serverId": 9,
          "rdmName": "NEW_DATABRIDGE_DB_NAME"
      }
    }
  }
}

Depending the parameters specified in the optional additionalDownloadOptions object, this operation will perform one of three options: 1) export and download a new RDM that contains the report, 2) export the report to a new RDM on Data Bridge, 3) export the report to an existing RDM on Data Bridge.

Option 1: To create and download a new RDM that contains the DOI report:

{
    "reportType": "EXPOSURE_DOI_REPORT",
    ...
    "settings": {
        "additionalDownloadOptions": {
            "rdm": {
                  "fileExtension": "BAK",
                  "sqlVersion": "2019",
                  "rdmName": "NEW_PLATFORM_RDM_NAME"
            }
        }
    }
}

Option 2: To create and download a new RDM on Data Bridge that contains the DOI report:

{
    "reportType": "EXPOSURE_DOI_REPORT",
    ...
    "settings": {
        "additionalDownloadOptions": {
            "rdmDatabridge": {
                  "serverId": 9,
                  "rdmName": "NEW_DATABRIDGE_RDM_NAME"
            }
        }
    }
}

Option 3: To export the DOI report to an existing RDM on Data Bridge:

{
    "reportType": "EXPOSURE_DOI_REPORT",
    ...
    "settings": {
        "additionalDownloadOptions": {
            "rdmDatabridge": {
                  "serverId": 9,
                  "databaseId": 111111111
            }
        }
    }
}

Risk Sources

The Create Risk Sources in Bulk operation (POST /platform/riskdata/v1/risksources/bulk-create) creates risk sources (RISKANALYSIS) in bulk for program or business hierarchy.

This operation supports the creation multiple RISKANALYSIS sources for the specified parent resource of the PROGRAM or BUSINESSHIERARCHYPOSITION type.

All parameters are specified in the body of the request. The riskSourcetype, parentType, and riskSources parameters are required.

{
  "riskSourceType": "RISKANALYSIS",
  "parentType": "PROGRAM",
  "parentId": 0,
  "parentUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "riskSources": [
    {
      "analysisId": 0,
      "perspectiveCode": "string",
      "name": "string",
      "description": "string",
      "segments": [
        "peril"
      ],
      "treatyIds": [
        0
      ],
      "addPortfolio": false
    }
  ]
}

Program Variations

The Search Program Variations operation (GET /platform/riskdata/v1/programvariations) returns a list of program variations.

This operation takes four query parameters: filter, sort, offset, limit. To learn more, see Filtering and Pagination.

The Get Program Variation operation (GET /platform/riskdata/v1/programvariations/programvariationId) returns the specified program variation.

The Delete Program Variation operation (DELETE /platform/riskdata/v1/programvariations/programvariationId) deletes the specified program variation.

Business Hierarchy Variations

The Search Business Hierarchy Variations operation (GET /platform/riskdata/v1/businesshierarchyvariations) returns a list of business hierarchy variations.

This operation takes five query parameters: filter, sort, offset, limit, and the Boolean includeLatestOnly. If true`, the response returns only the most recent business hierarchy in each business hierarchy set.

[
  {
    "businessHierarchyId": 0,
    "businessHierarchyVariationName": "string",
    "businessHierarchyVariationId": 0,
    "uri": "string",
    "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "createdBy": "string",
    "createdAt": "2024-05-15T20:37:13.099Z",
    "reference": "string",
    "outwardsReinsuranceProgramVariationId": 0,
    "businessHierarchySetSummary": {
      "businessHierarchySetName": "string",
      "businessHierarchySetId": 0,
      "businessOwner": "string",
      "description": "string",
      "primeBusinessHierarchyId": 0
    },
    "nodeCount": 0
  }
]

The Get Business Hierarchy Variation operation (GET /platform/riskdata/v1/programvariations/businesshierarchyvariationId) returns the specified business hierarchy variation.

The Delete Business Hierarchy Variation operation (DELETE /platform/riskdata/v1/programvariations/businesshierarchyvariationId) deletes the specified business hierarchy variation.