Returns a paginated list of the loss events registered in the ERM solution.
URL
{RMUrl}/api/objects/ERMEvent[?[[&]$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;
boolean Deleted;
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 loss events (by default, ten events are listed at a time):
{RMUrl}/api/objects/ERMEvent
Loss events 11 through 20 (second page):
{RMUrl}/api/objects/ERMEvent?page=2
Filter by loss events with IDs greater than 5:
{RMUrl}/api/objects/ERMEvent?$filter=Id gt 5
Filter by existing events:
{RMUrl}/api/objects/ERMEvent?$filter=Deleted eq false
Filter by deleted events:
{RMUrl}/api/objects/ERMCEvent?$filter=Deleted eq true
SUCCESS RESPONSE
List of loss events.
ERMEvent[].
The ERMEventobject is in the following format:
ERMEvent
{
int Id;
string Name;
string Description;
bool Deleted;
}
SUCCESS RESPONSE EXAMPLE
{
"Id": 52,
"Deleted": false,
"DateCreated": "/Date(1398703889957-0300)/",
"DateUpdated": "/Date(1398703889957-0300)/",
"Name": "Loss Event 1",
"LossEventResponsible": {
"Id": "942d78f0-2986-408d-96ba-0915bbcb76ce",
"Caption": "[API] userERM"
},
"Value": 1,
"AccountingDate": "/Date(1398643200000)/",
"Type": "Generic"
}