Back to All

April, 2024

about 2 months ago by Lan Le

🥥

Highlights

The April release introduces new risk data resources and support for SQL 2016.

  • New API Operations for Report Views, Programs, Business Hierarchies, Risk Sources
  • The Create Export Job operation now support exporting EDM and RDM insqlVersion 2016

Learn More

New API Operations

Report Views

A Risk Data Report View is a collection of reports and metrics required to drive UIQ use cases, generated as part of running an analysis template.

Search Report Views

The Search Report Views operation (GET /platform/riskdata/v1/reportviews) searches and lists the report views for a specified exposureID.

Sample Response Body:

[
    {
        "reportViewId": 2655,
        "reportViewName": "RV 1",
        "exposureName": "TEST",
        "createdAt": "2024-04-02T11:55:57.848Z",
        "exposureId": 720,
        "exposureResourceId": 21689,
        "exposureResourceType": "ACCOUNT",
        "exposureResourceTypeId": 8019,
        "createdBy": "[email protected]",
        "notes": ""
    },
    {
        "reportViewId": 2654,
        "reportViewName": "RV 2",
        "exposureName": "TEST",
        "createdAt": "2024-04-02T11:47:11.053Z",
        "exposureId": 720,
        "exposureResourceId": 22039,
        "exposureResourceType": "ACCOUNT",
        "exposureResourceTypeId": 8019,
        "createdBy": "[email protected]",
        "notes": ""
    }
]

This operation supports filtering, sorting, offsetting, and limiting the list of report views. To learn more, see Response Filtering.

Get Report View

The Get Report View operation (GET /platform/riskdata/v1/reportviews/{id}) returns a specific report view matching the ID provided.

Sample Response Body: 

{
    "reportViewId": 645,
    "reportViewName": "RV 3",
    "exposureName": "RMSTEST",
    "createdAt": "2024-03-22T14:19:31.317Z",
    "exposureId": 720,
    "exposureResourceId": 2854,
    "exposureResourceType": "ACCOUNT",
    "createdBy": "[email protected]",
    "notes": "",
    "details": [
        {
            "metricType": "PLT",
            "analysisId": 259438,
            "metricUrl": "https://api-euw1.rms-npe.com/platform/riskdata/v1/analyses/259438/plt?perspectiveCode=GU&exposureResourceId=2854&exposureResourceType=ACCOUNT",
            "additionalInfo": {
                "peril": "FL",
                "region": "US",
                "analysisName": "NewName1"
            }
        },
        {
            "metricType": "EP",
            "analysisId": 259438,
            "metricUrl": "https://api-euw1.rms-npe.com/platform/riskdata/v1/analyses/259438/ep?perspectiveCode=GR&exposureResourceId=2854&exposureResourceType=ACCOUNT",
            "additionalInfo": {
                "peril": "FL",
                "region": "US",
                "analysisName": "NewName2"
            }
        }
    ]
}

Programs

Create Program

The Create Program operation (POST/platform/riskdata/v1/programsets/{programSetId}/programs) creates a program secured under the programSetId specified

This request accepts the optional x-rms-requestId request header which enables idempotency.

If successful, the response returns 201 Created with the Location header denoting the created program.

Create Outward Program

The Create Outward Program operation (POST/platform/riskdata/v1/businesshierarchysets/{businessHierarchySetId}/programs) creates an outward program secured directly under the businessHierarchySetId specified

This request accepts the optional x-rms-requestId request header which enables idempotency.

If successful, the response returns 201 Created with the Location header denoting the created program.

Search Programs

The Search Programs operation (GET/platform/riskdata/v1/programs) searches and lists the programs (incl. outward programs).

This operation supports filtering, sorting, offsetting, and limiting the list of programs. To learn more, see Response Filtering.

Get Program

The Get Program operation (GET/platform/riskdata/v1/programs/{programId}) retrieves a specific program (incl. outward program) identified by the programId specified.

Update Program

The Update Program operation (PATCH/platform/riskdata/v1/programs/{programId}) updates a program identified by the programId specified.

This operation can perform partial updates when a subset of appropriate request fields is passed.

Delete Program

The Delete Program operation (DELETE/platform/riskdata/v1/programs/{programId}) deletes a program identified by the programId specified.

Business Hierarchies

Create Business Hierarchy

The Create Business Hierarchy operation (POST/platform/riskdata/v1/businesshierarchysets/{businessHierarchysetId}/businessHierarchies) creates a Business Hierarchy secured under the businessHierarchysetId specified

This request accepts the optional x-rms-requestId request header which enables idempotency.

If successful, the response returns 201 Created with the Location header denoting the created business hierarchy.

Search Business Hierarchies

The Search Business Hierarchies operation (GET/platform/riskdata/v1/businessHierarchies) searches and lists the business hierarchies.

This operation supports filtering, sorting, offsetting, and limiting the list of business hierarchies. To learn more, see Response Filtering.

Get Business Hierarchy

The Get Business Hierarchy operation (GET/platform/riskdata/v1/businessHierarchies/{businessHierarchyId}) retrieves a specific business hierarchy identified by the businessHierarchyId specified.

Update Business Hierarchy

The Update Business Hierarchy operation (PATCH/platform/riskdata/v1/businessHierarchies/{businessHierarchyId}) updates a business hierarchy identified by the businessHierarchyId specified.

This operation can perform partial updates when a subset of appropriate request fields is passed.

Delete Business Hierarchy

The Delete Business Hierarchy operation (DELETE/platform/riskdata/v1/businessHierarchies/{businessHierarchyId}) deletes a business hierarchy identified by the businessHierarchyId specified.

Risk Sources

Bulk Create Risk Sources

The Bulk Create Risk Sources operation (POST/platform/riskdata/v1/risksources/bulk-create) creates one or more risk sources under a parent, which can be an existing program or business hierarchy position.

Currently, the operation supports any risk analysis identified by analysisId to create the risk sources.

Sample Request Body

{
 ,
  "parentType": "PROGRAM",
  "parentId": 123456,
  "riskSources": [
    {
      "addCedantExposure": true,
      "extendDates": true,
      "riskSourceType": "RISKANALYSIS",
      "analysisId": 132,
      "perspectiveCode": "GU",
      "name": "Test",
      "description": "New Risk source",
      "segments": [
        "cedant",
        "country"
      ],
      "treatyIds": [
        1,
        4
      ]
    }
  ]
}

Existing API Updates

Export API

Create Export Job

The Create Export Job operation (POST /platform/export/v1/jobs) now supports sqlVersion as 2016 in the EDM or RDM export job request.

Sample Request Body: Export EDM

{
    "exportType": "EDM",
    "resourceType": "EXPOSURE",
    "resourceUri": "/platform/riskdata/v1/exposures/175894",
    "settings": {
        "fileExtension": "BAK",
        "fileName": "testMar11irp_2016",
        "sqlVersion": "2016"
    }
}

Sample Request Body: Export RDM

{
    "exportType": "RDM",
    "resourceType": "ANALYSES",
    "resourceUris": [
        "/platform/riskdata/v1/analyses/175074"
    ],
    "settings": {
        "fileExtension": "BAK",
        "rdmName": "test11MarDeploy_2016_rdm",
        "sqlVersion": "2016"
    }
}

The sqlVersion parameter can be provided for the request payload field with the following supported values: 2014, 2016, 2019.