Overview

A resource URI is global and unique identifier for a resource instance (e.g. a specific portfolio) on the Intelligent Risk Platform. This URI identifies this object throughout a tenant's Intelligent Risk Platform implementation regardless of application, exposure set, or data module (EDM).

Resource URIs facilitate workflow integration across all Intelligent Risk Platform functions. Clients can always identify specific API resources (exposures, databases, jobs) in all contexts and manage those API resources using API operations and workflows.

Resource URI format

A resource URI is nearly identical to the URL of an API resource, i.e. the portion of an endpoint used to retrieve (GET), update (PUT, PATCH), and delete (DELETE) that API resource. For example,

curl --request GET \
     --url https://api-euw1.rms.com/platform/riskdata/v1/exposures/23/accounts/555 \
     --header 'accept: application/json'

The format of a resourceUri parameter is nearly identical, but excludes the scheme (https://) and host (e.g. api-euws1.rms.com).

The following request defines an EXPOSURE_RESOURCE export job by which the specified account exposure is exported:

{
  "exportType": "EXPOSURE_RESOURCE",
  "resourceType": "account",
  "settings": {
    "fileExtension": "PARQUET",
    "fileName": "myFile"
  },
  "resourceUri": "/platform/riskdata/v1/exposures/23/accounts/555"
}

The following request defines an EDM export job by which the specified list of account exposure is exported:

{
  "exportType": "EDM",
  "resourceType": "exposure",
  "settings": {
    "fileExtension": "BAK",
    "sqlVersion": "2019",
    "filters": {
      "exposureResourceType": "ACCOUNTS",
      "exposureResourceIds": [
        "/platform/riskdata/v1/exposures/23/accounts/555",
        "/platform/riskdata/v1/exposures/23/accounts/556",
        "/platform/riskdata/v1/exposures/23/accounts/557"
      ]
    },
    "fileName": "myEDM"
  },
  "resourceUri": "/platform/riskdata/v1/exposures/5555"
}