Returns a paginated list of the enterprise controls registered in the ERM solution.
URL
{RMUrl}/api/objects/ERMControl[?[[&]$$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 controls (by default, ten controls are listed at a time):
{RMUrl}/api/objects/ERMControl
Controls 11 through 20 (second page):
{RMUrl}/api/objects/ERMControl?page=2
Filter by controls with IDs greater than 5:
{RMUrl}/api/objects/ERMControl?$filter=Id gt 5
Filter by existing controls:
{RMUrl}/api/objects/ERMControl?$filter=Deleted eq false
Filter by deleted controls:
{RMUrl}/api/objects/ERMControl?$filter=Deleted eq true
SUCCESS RESPONSE
List of enterprise controls.
ERMControl[].
The ERMControl object is in the following format:
ERMControl
{
int Id;
string Name;
string Description;
bool Deleted;
}
SUCCESS RESPONSE EXAMPLES
[
{"Id":29,
"Name":"Audit the backup logs",
"Description":"Backups should be executed according to the frequency defined in the safety policy. The execution must be registered in the system or manually, and these logs should be verified to check the execution of the backups.",
"Deleted":false
},
{
"Id":28,
"Name":"Annual internal audit",
"Description":"The annual internal audit should be conducted to proactively identify problems and non-conformities of the company.",
"Deleted":false
}]