Package org.opennms.features.reporting.rest

Interface ReportRestService

All Known Implementing Classes:

ReportRestServiceImpl

@Path("/reports")
@Produces("application/json")
@Consumes("application/json")
public interface ReportRestService

Method Summary

Modifier and Type	Method	Description
javax.ws.rs.core.Response	deletePersistedReport(int id)
javax.ws.rs.core.Response	deletePersistedReports()
javax.ws.rs.core.Response	deleteScheduledReport(String triggerName)
javax.ws.rs.core.Response	deleteScheduledReports()
javax.ws.rs.core.Response	deliverReport(Map<String,Object> parameters)
javax.ws.rs.core.Response	downloadReport(String format, String locatorId)
javax.ws.rs.core.Response	getReportDetails(String reportId, String userId)
javax.ws.rs.core.Response	getSchedule(String triggerName)
javax.ws.rs.core.Response	listPersistedReports(javax.ws.rs.core.UriInfo uriInfo)
javax.ws.rs.core.Response	listReports()
javax.ws.rs.core.Response	listScheduledReports(javax.ws.rs.core.UriInfo uriInfo)
javax.ws.rs.core.Response	runReport(String reportId, Map<String,Object> inputParameters)
javax.ws.rs.core.Response	scheduleReport(Map<String,Object> parameters)
javax.ws.rs.core.Response	updateSchedule(String triggerName, Map<String,Object> parameters)

Method Detail

listReports

@GET
javax.ws.rs.core.Response listReports()

getReportDetails

@GET
@Path("/{id}")
javax.ws.rs.core.Response getReportDetails(@PathParam("id")
                                           String reportId,
                                           @QueryParam("userId")
                                           String userId)

runReport

@POST
@Path("/{id}")
javax.ws.rs.core.Response runReport(@PathParam("id")
                                    String reportId,
                                    Map<String,Object> inputParameters)

listPersistedReports

@GET
@Path("/persisted")
javax.ws.rs.core.Response listPersistedReports(@Context
                                               javax.ws.rs.core.UriInfo uriInfo)

deletePersistedReports

@DELETE
@Path("/persisted")
javax.ws.rs.core.Response deletePersistedReports()

deliverReport

@POST
@Path("/persisted")
javax.ws.rs.core.Response deliverReport(Map<String,Object> parameters)

deletePersistedReport

@DELETE
@Path("/persisted/{id}")
javax.ws.rs.core.Response deletePersistedReport(@PathParam("id")
                                                int id)

listScheduledReports

@GET
@Path("/scheduled")
javax.ws.rs.core.Response listScheduledReports(@Context
                                               javax.ws.rs.core.UriInfo uriInfo)

getSchedule

@GET
@Path("/scheduled/{triggerName}")
javax.ws.rs.core.Response getSchedule(@PathParam("triggerName")
                                      String triggerName)

updateSchedule

@PUT
@Path("/scheduled/{triggerName}")
javax.ws.rs.core.Response updateSchedule(@PathParam("triggerName")
                                         String triggerName,
                                         Map<String,Object> parameters)

deleteScheduledReports

@DELETE
@Path("/scheduled")
javax.ws.rs.core.Response deleteScheduledReports()

scheduleReport

@POST
@Path("/scheduled")
javax.ws.rs.core.Response scheduleReport(Map<String,Object> parameters)

deleteScheduledReport

@DELETE
@Path("/scheduled/{id}")
javax.ws.rs.core.Response deleteScheduledReport(@PathParam("id")
                                                String triggerName)

downloadReport

@GET
@Path("/download")
javax.ws.rs.core.Response downloadReport(@QueryParam("format")
                                         String format,
                                         @QueryParam("locatorId")
                                         String locatorId)