RBI 581 API service

An RBI 581 API service is available. This can be accessed via the IMS Developer Portal. This portal acts as a bridge between IMS and developers, allowing third parties to develop apps that can access and use the data stored and managed in IMS.

The base function, APIRBI581ProbabilityOfFailure, allows the caller to calculate a single input object, while the Batch variant enables the processing of a list of objects. The FTBatch variant facilitates data transfer using a shared file between the client and server. These structures mirror those used in the MTIAService.

Additionally, the IMS Developer Portal displays the current schema for the objects and the required data inputs.

Input object:

Result object:

The RBI581Client library enables the calling services, such as the IMS Dataservice in this case, to interact with this service. It follows the same procedures as those used with MTIAService.

var client = new APIRBI581Client.APIRBIPoFClient(input);
client.Execute();
var result = client.APIRBIResult.FirstOrDefault();

The code below handles the service connection and prepares the data transfer according to its configuration. This configuration is specified in the Config.json file under the following section:

"Services": {  ...  "APIRBI581": {
    "Url": "https://localhost:51928/", //Address where the service is found
    "FileTransferLocation": "C:\\Data\\w-IMS\\Trending", //Common folder for the use of filetransfer
    "UseFileTransfer": true, //Whether to use file transfers for data communication
    "FileTransferPrefix": "APIRBI581" //The prefix on files used for the filetransfer
  }
  ...}

Config Service for PoF Calculations

APIRBI581Service is the WebAPI service responsible for handling APIRBI581 PoF calculations.

It has been added to the w-PEMS - Full.sln solution and can be set as a startup project. There is also a standalone solution, APIRBI581Service.sln, which includes only the service and its dependencies.

The service runs on .NET Core 8, so the 64-bit version of the .NET Core 8 runtime must be installed for it to function properly.

Since the service operates in a 64-bit environment, the latest version of R can (and should) be used. After installing R, it must be run as an administrator to install the R.utils package:

install.packages("R.utils")

After the install is finished the service should be ready to run.

The following section needs to be added in Dataservice/Content/Config.json:

"Services": {

  ...

  "APIRBI581": {

    "Url": "${location of APIRBI581 service}",

    "FileTransferLocation": "${location of shared folder}",

    "UseFileTransfer": false,

    "FileTransferPrefix": "APIRBI581"

  },

  ...

}

UseFileTransfer can be set to true to enable file transfer, but this is currently not required. If enabled, a shared folder must be configured. To set up the service for using a shared folder, the necessary setting should be added to the appsettings.json file in APIRBI581Service:

"FileTransferLocation": "${location of shared folder}"

DO NOT ADD ANY WEB.CONFIG OR ANY OTHER FOREIGN FILES TO THE APIRBI581Service. The service is designed to run with minimal configuration.

Learn more

To learn more about the IMS Portal see: IMS Developer Portal.