Overview

A resource URI is global and unique identity of an entity on the Intelligent Risk Platform. The resource URI enables user-friendly API integration through the workflows across platform functions.

A resource a callable unit of a RESTful API that consists of an HTTP method (e.g. GET, POST, DELETE) and a URL that consists of a scheme, host, and a path that identifies the resource.

The host identifies the data center that hosts your company's tenant instance: api-euw1.rms.com or api-use1.rms.com. The host is sometimes referred to as the {host} variable in Postman collections and some code samples. Whenever you see the {host} variable in an example, you must substitute the correct host name.

The path consists of an app path, base path, and operation path.

• The app path identifies the RMS application. For example, /riskmodeler or /databridge.
• The base path identifies the version number of the resource. Platform APIs are periodically upgraded and versioned. To learn more about Platform versioning policies, see Policies.
• The operation path defines a path to a resource. The operation path may include path parameters and query parameters. Our API Reference documentation provides detailed information about the parameters that may be defined in the path of each service. To learn more about Platform query parameters, see Response Filtering.

Retrieve entities

Most resource URIs can be used to retrieve the entity itself through GET operation

A portfolio has an unique resourceUri on the entire tenant as

/platform/riskdata/v1/exposures/21323/portfolios/12

This resource URI identifies the portfolio with id "12" within the exposure with the id "21323"

The entity's unique resource URI can be used as input to retrieve data or to identify that entity in another operation:

• Model API to perform a model run
• Import API to perform MRI import
• Call GET /platform/riskdata/exposures/21323/portfolios/12 to retrieve the portfolio