Overview

A resource URI is global and unique identifier for an instance of an API resource (e.g. a specific portfolio) on the Intelligent Risk Platform. This URI identifies that instance 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.

A resource URI may be referenced as a value of a resourceUri parameter or as an array of values in a resourceUris parameter.

Single resource URI

The Create Export Job operation enables you to define and initiate an EXPOSURE_RESOURCE job that exports the specified exposure. This exposure is identified by its resource URI and is specified in the resourceUri parameter.

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

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, but excludes the scheme (https://) and host (e.g. api-euws1.rms.com).

Array of resource URIs

The Create Export Job operation also enables you to define and initiate an EDM job that exports an array of EDMs.

These EDMS are identified by resource URI and are specified specified in the exposureResourceIds parameter:

{
  "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"
}

📷

Note

Depending on the operation, Platform APIs sometimes limit the number resource URIs that can be specified in a request. For example, the Create Export Job limits the number of analysis results that can be exported in a single RDM job to 100. Limits are identified as the length of the array.