Package org.opennms.web.rest.v1
Class OutageRestService
- java.lang.Object
-
- org.opennms.web.rest.v1.OnmsRestService
-
- org.opennms.web.rest.v1.OutageRestService
-
@Component("outageRestService") public class OutageRestService extends OnmsRestService
TODO: Add functionality to getting outages by: nodelabel, nodeid, foreignsource, foreignsource+foreignid, ipaddress, etc. add filters for current, resolved, allREST service to the OpenNMS Outage
OnmsOutage
data.This service supports getting the list of outages or one specific outage by ID:
Example 1: Query List of outages.
curl -v -X GET -u admin:admin http://localhost:8980/opennms/rest/outages
- Since:
- 1.8.1
- Version:
- $Id: $
- Author:
- Craig Miskell
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.opennms.web.rest.v1.OnmsRestService
OnmsRestService.ComparisonOperation
-
-
Field Summary
-
Fields inherited from class org.opennms.web.rest.v1.OnmsRestService
DEFAULT_LIMIT
-
-
Constructor Summary
Constructors Constructor Description OutageRestService()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description OnmsOutageCollection
forNodeId(javax.ws.rs.core.UriInfo uriInfo, int nodeId, long dateRange, Long startTs, Long endTs)
forNodeIdString
getCount()
getCountjavax.ws.rs.core.Response
getOutage(javax.ws.rs.core.UriInfo uriInfo, String outageId)
getOutageOnmsOutageCollection
getOutages(javax.ws.rs.core.UriInfo uriInfo)
getOutages-
Methods inherited from class org.opennms.web.rest.v1.OnmsRestService
applyQueryFilters, applyQueryFilters, getBadRequestResponse, getBeanWrapperForClass, getException, getException, getNumericValue, getRedirectUri, readLock, readUnlock, removeParameter, removeParameter, setProperties, writeLock, writeUnlock
-
-
-
-
Method Detail
-
getOutage
@Transactional public javax.ws.rs.core.Response getOutage(@Context javax.ws.rs.core.UriInfo uriInfo, String outageId)
getOutage
- Parameters:
outageId
- aString
object.- Returns:
- a
OnmsOutage
object.
-
getOutages
@Transactional public OnmsOutageCollection getOutages(@Context javax.ws.rs.core.UriInfo uriInfo)
getOutages
- Returns:
- a
OnmsOutageCollection
object.
-
forNodeId
@Transactional public OnmsOutageCollection forNodeId(@Context javax.ws.rs.core.UriInfo uriInfo, int nodeId, long dateRange, Long startTs, Long endTs)
forNodeId
- Parameters:
nodeId
- a int.dateRange
- a long.startTs
- a java.lang.Long.endTs
- a java.lang.Long.- Returns:
- a
OnmsOutageCollection
object.
-
-