An abstract data access layer API, meant to (somewhat) mirror the DAO interfaces inside OpenNMS. Used to retrieve model data like alarms, events, etc. from the OpenNMS ReST API in a consistent way.
the ID/key type (number, string, etc.)
the model type (OnmsAlarm, OnmsEvent, etc.)
Find all model objects given an optional filter.
the filter to use when retrieving a list of model objects
Finds the values for the given propertyId, if it exists.
The propertyId to find the values for
Some additional options. May be implementer dependent, such as limit, or value restrictions
A promise containing the values.
Retrieve a model object.
the ID of the object
Retrieve the API version from the currently configured server.
A convenience method to make it easy for implementers to extract the count (or totalCount) values from response data.
Return the current server.
Fetches the data from the result and verfifes that the
dataFieldName exists in the data property.
If it does not exist, an exception is thrown.
The result to fetch the data from
The property name (basically
The path where the result was fetched from. This is for error handling
Callback function to convert each entry from
Get the list properties that can be used in queries.
Gets the property identified by the id if it exists.
The id to search the property by.
The path to retrieve search properties for this DAO.
Convert the given value to a date, or undefined if it cannot be converted.
Convert the given value to a number, or undefined if it cannot be converted.
Whether or not to use JSON when making ReST requests.
Generated using TypeDoc