Retrieving Multiple Suppliers' Risk Exposure Using the Risk Exposure API

Use these steps to retrieve the overall and category risk exposure for up to 500 suppliers monitored in SAP Ariba Supplier Risk. You can then integrate the information into other SAP Ariba applications.

Prerequisites

  • If not already done, a customer administrator or a member of the Supplier Risk Manager group completes the risk exposure configuration in SAP Ariba Supplier Risk. Refer to Topics About Configuring Risk Exposure for more information on configuring risk exposure.

  • For each supplier, determine the SM vendor ID or ERP vendor ID. You can use SM vendor IDs and ERP vendor IDs in the same API call.

Context

The Risk Exposure API gets the result of the overall risk exposure and category risk exposure for all custom categories, for the suppliers monitored in SAP Ariba Supplier Risk. The Risk Exposure API doesn't include risk incidents.

The paginated results include 100 suppliers per page.

The risk exposure from the Risk Exposure API is based on the below thresholds resulting from the risk exposure configurations. The thresholds are used to determine the level of risk for that contributing factor. Each level of risk has an assigned value.
  • Unknown

    There isn't enough information to calculate the risk exposure, or there are no recent updates to the contributing factors for calculating the current risk exposure.

  • Low

    The supplier's level of risk exposure is low.

  • Medium

    The supplier's level of risk exposure is medium.

  • High

    The supplier's level of risk exposure is high.

Procedure

  1. The administrator identifies the SM vendor IDs or ERP vendor IDs and system realm for the suppliers.
  2. The client application sends a request that passes the locale (optional), number of suppliers per page, realm, SM vendor IDs, ERP vendor IDs, source system, and page number using the POST /suppliers/exposureRequest/pages/{pageNo} endpoint.
    POST {{runtime_url}}/suppliers/exposureRequest/pages/{pageNo}
    {
      "smVendorIds": [
          "S123456",
          "S234567"
      ],
      "erpVendorIds": [
          "ABC123",
          "EFG456"
      ],
      "sourceSystem": "SAP"
    }
    Request Parameters

    Name

    Required?

    Description

    Accept-Language

    No

    The locale used to fetch the translated entity name.

    The default locale is en.

    Two locales can be specified as comma separated values. The second locale corresponds to the fallback locale.

    For more information, refer to Locale Settings for Risk Exposure API Responses.

    maxPageSize

    No

    The number of suppliers per page.

    realm

    Yes

    The system realm where the supplier and risk exposure exist.

    smVendorIds

    Yes, unless you're using erpVendorIds.

    The supplier you want the risk exposure for.

    erpVendorIds

    Yes, unless you're using smVendorIds.

    The supplier you want the risk exposure for.

    sourceSystem

    Yes, if you're using erpVendorIds

    The system where the information is being requested.

    pageNo

    Yes

    The beginning page number for the next page of output.

Results

On success, the response includes a 200 success code.

The response returns paginated results with the suppliers, their overall exposure, and their risk category exposures.

{
  “suppliers”: [
  {
     “realm”: “myRealm”,
     “smVendorId”: “S12345678”,
     “erpVendorId”: “98765abcde”,
     “sourceSystem”: “SAP”,
     “exposureId”: 12345,
     “exposureCalculationDate”: “2023-02-21",
     “exposure”: 60,
     “exposureLevel”: 3,
        "exposureLevelName": "MEDIUM",
        "localizedExposureLevelName": "Medium",
     “riskCategoryExposures”: [
  {
     “name”: “FINANCIAL”,
        "localizedName": "Financial",
        "weight": 25,
	“exposure”: 30,
	“exposureLevel”: 60,
           "exposureLevelName": "MEDIUM",
           "localizedExposureLevelName": "Medium"
  },
  {
      “name”: “BANKING”,
        "localizedName": "Banking",
        "weight": 20, 
	“exposure”: 25,
	   “exposureLevel”: 60,
           "exposureLevelName": "MEDIUM",
           "localizeExposureLevelName": "Medium"
  }
      ],
	“responseTimeStamp”: “2023-02-28 10:55:04.000000248”,
	“exposureConfigurationVersion”: “33”
  }
      ]
 }
Risk Exposure API Results

Properties

Definition

Realm

The realm where the risk exposure information was requested.

SM vendor ID

The supplier's ID in the SAP Ariba Supplier Risk system.

ERP vendor ID

The supplier's ID in the ERP system.

Source system

The system where the information was requested.

Exposure ID

A unique identifier created every time the risk exposure is calculated.

Exposure calculation date

The date the exposure was last calculated for the supplier.

Exposure

The overall risk exposure for the supplier. The value is a number between 1–100.

Exposure level

The overall risk exposure level for the supplier. The overall level of risk exposure is high, medium, low, or unknown. Unknown risk exposure is due to lack of information for calculation or lack of recent updates.

Exposure level name

The name of the supplier's overall risk exposure level. The overall level of risk exposure is high, medium, low, or unknown. Unknown risk exposure is due to lack of information for calculation or lack of recent updates.

Localized exposure level name

The translated name of the supplier's overall risk exposure level.

Risk category name

The name of the risk category. For example, regulatory and legal, environmental and social, operational, or financial.

Risk category localized name

The translated name of the risk category.

Risk category weight

The weight value of the risk category.

Risk category exposure

The category risk exposure for the supplier. Each category can have a value of 1–100.

Risk category exposure level

The supplier's level of risk exposure for the risk category. The risk category level of risk exposure is high, medium, low, or unknown. Unknown risk exposure is due to lack of information for calculation or lack of recent updates.

Risk category exposure level name

The name of the supplier's exposure level for the risk category. The risk category level of risk exposure is high, medium, low, or unknown. Unknown risk exposure is due to lack of information for calculation or lack of recent updates.

Risk category localized exposure level name

The translated name of the risk category exposure level.

Response timestamp

The time when the information was retrieved from the system.

Exposure configuration version

The version of your risk exposure configuration that was used for the risk exposure information retrieved from the system.

On failure, the response includes an error message. Refer to Risk Exposure API Error Messages for a list of possible errors.