com.iland.core.web.rest.api

Interface EventResource

All Superinterfaces:

Serializable

@Path(value="/events")
 @Consumes(value="application/json")
 @Produces(value="application/vnd.ilandcloud.api.v1.0+json")
public interface EventResource
extends Serializable

Event REST resource V1.

Author:

Cory Snyder

Method Summary

Modifier and Type	Method and Description
EventResponse	getEvent(String uuid) Get an event by its UUID.
EventListResponse	getEvents(EventFilterParams filters) Allows a client to perform dynamic event queries.

Method Detail

getEvents

@GET
 @Produces(value="application/vnd.ilandcloud.api.v1.0+json")
EventListResponse getEvents(@BeanParam
                                                                                              EventFilterParams filters)

Allows a client to perform dynamic event queries.

Returns:

the list of queried events

getEvent

@GET
 @Path(value="/{uuid}")
 @Produces(value="application/vnd.ilandcloud.api.v1.0+json")
EventResponse getEvent(@PathParam(value="uuid")
                                                                                                                 String uuid)

Get an event by its UUID.

Parameters:

uuid - the UUID of the event to retrieve

Returns:

the event