List KRIs

Returns a paginated list of the KRIs registered in the ERM solution.

URL

RMUrl}/api/enterpriseriskmanagement/kris[?[[&]$filter=<Filter>][[&]page=<Page>][[&]page_size=<PageSize>][[&]$orderby=<field1[desc],field2[desc]…fieldN[desc]>]]

REQUEST METHOD

GET

URL PARAMETERS

page: Number of the page to be displayed. Valid values: 1 to the maximum number of pages. If omitted, the value 1 is used. If the value is greater than the maximum number of pages, a blank list will be returned.

page_size: Number of items displayed per page. Valid values: 1 to 1,000. If omitted, the default value of 10 is used.

filter: Query based on the OData protocol syntax for configuring filters. The fields supported are listed below. See the examples to view the operations allowed.

orderby: Orders the instances listed on the page by field. To order by more than one field, use a comma between the field names. For descending order, add the word "desc" to each field. The supported fields are listed below.

FIELDS SUPPORTED BY FILTER

byte Id;

string Name;

string Variable;

string Description;

double LastValue;

int LastStatus/Id;

int ErmRisk/Id;

int OperationType/Id;

string MonitoredLossEventField;

guid MonitoredLossEventType/Id;

string LastLevel/Color;

string LastLevel/Name;

int LastLevel/Index;

double LastLevel/MinValue;

double LastLevel/MaxValue;

datetime LastProcessed;

string Author/Name;

guid Author/Id;

Note: For detailed information on filters as supported operators, which filters apply to which data types, and more examples, see Appendix 3: Filters.

REQUEST EXAMPLES

List KRIs (by default, ten KRIs are listed at a time):

{RMUrl}/api/enterpriseriskmanagement/kris

KRIs 11 through 20 (second page):

{RMUrl}/api/enterpriseriskmanagement/kris?page=2

Filter by KRIs with IDs greater than 5:

{RMUrl}/api/enterpriseriskmanagement/kris?$filter=Id gt 5

Filter by KRIs with maximum threshold equal to 2060:

{RMUrl}/api/enterpriseriskmanagement/kris?$filter=LastLevel/MaxValue eq 2060

SUCCESS RESPONSE

List of KRIs.

ERMKRri[].

The ERMKri object is in the following format:

ERMKri

{

int Id;

string Name;

string Variable;

string Description;

int LastValue;

object LastStatus;

object ErmRisk;

object OperationType;

object MonitoredLossEventType;

object Conditions;

object Thresholds;

object LastLevel;

object Author;

string MonitoredLossEventField;

DateTime LastProcessed;

}

SUCCESS RESPONSE EXAMPLE

[

{

"Id":21,

"Name":"Financing KRI",

"Variable":"financing0001",

"Description":"indicator of financing risk",

"ErmRisk":{"Id":6188},"OperationType":{"Name":"Sum","Id":1},

"MonitoredLossEventField":"number_all",

"MonitoredLossEventType":{"Id":"75eca6ad-2689-11e5-80dc-00155d00020d","Name":"Type 1"},

"Conditions":[{"LeftOperandName":"Value","RightOperandName":"12.0","Operator":{"Id":3,"Name":"is greater than or equal to"}}],

"Thresholds":

[

{"Color":"lawnGreen","Name":"!@#$%¨&*( low","Index":0,"MinValue":-3.40282347E+38,"MaxValue":90.0},

{"Color":"yellow","Name":"[medium]","Index":1,"MinValue":90.0,"MaxValue":200.0},

{"Color":"red","Name":"High","Index":2,"MinValue":200.0,"MaxValue":3.40282347E+38}

]

}