Package org.opennms.web.rest.v2.api

Interface EventRestApi

  • All Known Implementing Classes:
    EventRestService
    @Path("events")
public interface EventRestApi

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      javax.ws.rs.core.Response create​(Event event)  
      javax.ws.rs.core.Response get​(javax.ws.rs.core.UriInfo uriInfo, Integer id)  
      javax.ws.rs.core.Response get​(javax.ws.rs.core.UriInfo uriInfo, org.apache.cxf.jaxrs.ext.search.SearchContext searchContext)  
      javax.ws.rs.core.Response getCount​(javax.ws.rs.core.UriInfo uriInfo, org.apache.cxf.jaxrs.ext.search.SearchContext searchContext)  
      javax.ws.rs.core.Response getProperties​(String query)  
      javax.ws.rs.core.Response getPropertyValues​(String propertyId, String query, Integer limit)  

    • Method Detail

      • get

        @GET
@Produces({"application/json","application/xml","application/atom+xml"})
javax.ws.rs.core.Response get​(@Context
                              javax.ws.rs.core.UriInfo uriInfo,
                              @Context
                              org.apache.cxf.jaxrs.ext.search.SearchContext searchContext)

      • get

        @GET
@Path("{id}")
@Produces({"application/json","application/xml","application/atom+xml"})
javax.ws.rs.core.Response get​(@Context
                              javax.ws.rs.core.UriInfo uriInfo,
                              @PathParam("id")
                              Integer id)

      • getCount

        @GET
@Path("count")
@Produces("text/plain")
javax.ws.rs.core.Response getCount​(@Context
                                   javax.ws.rs.core.UriInfo uriInfo,
                                   @Context
                                   org.apache.cxf.jaxrs.ext.search.SearchContext searchContext)

      • getProperties

        @GET
@Path("properties")
@Produces({"application/json","application/xml"})
javax.ws.rs.core.Response getProperties​(@QueryParam("q")
                                        String query)

      • getPropertyValues

        @GET
@Path("properties/{propertyId}")
@Produces({"application/json","application/xml"})
javax.ws.rs.core.Response getPropertyValues​(@PathParam("propertyId")
                                            String propertyId,
                                            @QueryParam("q")
                                            String query,
                                            @QueryParam("limit")
                                            Integer limit)

      • create

        @POST
@Path("{tiebreaker: $}")
@Consumes({"application/json","application/xml"})
javax.ws.rs.core.Response create​(@RequestBody
                                 Event event)