Returns a paginated list of the enterprise risks.
URL
{RMUrl}/api/objects/ERMRisk[?[[&]$$filter=<FilterCriteria>][[&]page=<PageNumber>][[&]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;
boolean Deleted;
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 the enterprise risks (by default, ten risks are listed at a time):
{RMUrl}/api/objects/ERMRisk
Risks 11 through 20 (second page):
{RMUrl}/api/objects/ERMRisk?page=2
Filter by risks with IDs greater than 5:
{RMUrl}/api/objects/ERMRisk?$filter=Id gt 5
Filter by existing risks:
{RMUrl}/api/objects/ERMRisk?$filter=Deleted eq 'false'
Filter by deleted risks:
{RMUrl}/api/objects/ERMRisk?$filter=Deleted eq 'false'
SUCCESS RESPONSE
List of enterprise risks.
ERMRisk[].
The ERMRisk object is in the following format:
ERMRisk
{
int Id;
string Name;
string Description;
string Type;
singleselect Category;
double InherentImpact;
double ResidualImpact;
formula InherentRiskScore;
formula ResidualInherentRiskScore;
double InherentProbability;
double ResidualProbability;
humanresourcesinglerelationship RiskOwner;
riskcontrolmultiplerelationship? Controls;
bool Deleted;
}
SUCCESS RESPONSE EXAMPLES
[
{
"Id":31,
"Deleted":false,
"Name":"Unfair competition",
"Category":"External",
"Description":"Competition through illegal actions.",
"RiskOwner":{"Id":"072b63aa-fea8-11e1-94b3-001ec91f4b0a","Caption":"Joshua Blue"},
"InherentImpact":180.0,
"InherentProbability":20.0,
"InherentRiskScore":{"Status":"Ok","Value":3600.0},
"ResidualImpact":5.0,
"ResidualProbability":4.0,
"ResidualInherentRiskScore":{"Status":"Ok","Value":20.0},
"Controls":[{"Id":28,"Caption":"Annual internal audit"}],
"Type":"Market Risk"
},
{
"Id":24,
"Deleted":false,
"Name":"Low cash flow",
"Category":"External",
"Description":"Deficit of cash on hand to honor everyday payments.",
"RiskOwner":{"Id":"066f2b90-7172-4dd4-b52f-5c443d91d35f","Caption":"John Smith"},
"InherentImpact":10.0,
"InherentProbability":5.0,
"InherentRiskScore":{"Status":"Ok","Value":50.0},
"ResidualImpact":5.0,
"ResidualProbability":2.0,
"ResidualInherentRiskScore":{"Status":"Ok","Value":10.0},
"Controls":[{"Id":27,"Caption":"Comply with the federal labor law "},{"Id":29,"Caption":" Audit the backup logs"}],
"Type":"Credit Risk"}
]