Package org.opennms.features.reporting.rest

Interface ReportRestService

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      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​(java.lang.String triggerName)  
      javax.ws.rs.core.Response deleteScheduledReports()  
      javax.ws.rs.core.Response deliverReport​(java.util.Map<java.lang.String,​java.lang.Object> parameters)  
      javax.ws.rs.core.Response downloadReport​(java.lang.String format, java.lang.String locatorId)  
      javax.ws.rs.core.Response getReportDetails​(java.lang.String reportId, java.lang.String userId)  
      javax.ws.rs.core.Response getSchedule​(java.lang.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​(java.lang.String reportId, java.util.Map<java.lang.String,​java.lang.Object> inputParameters)  
      javax.ws.rs.core.Response scheduleReport​(java.util.Map<java.lang.String,​java.lang.Object> parameters)  
      javax.ws.rs.core.Response updateSchedule​(java.lang.String triggerName, java.util.Map<java.lang.String,​java.lang.Object> parameters)  

    • Method Detail

      • listReports

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

      • getReportDetails

        javax.ws.rs.core.Response getReportDetails​(java.lang.String reportId,
                                           java.lang.String userId)

      • runReport

        javax.ws.rs.core.Response runReport​(java.lang.String reportId,
                                    java.util.Map<java.lang.String,​java.lang.Object> inputParameters)

      • listPersistedReports

        javax.ws.rs.core.Response listPersistedReports​(@Context
                                               javax.ws.rs.core.UriInfo uriInfo)

      • deletePersistedReports

        javax.ws.rs.core.Response deletePersistedReports()

      • deliverReport

        javax.ws.rs.core.Response deliverReport​(java.util.Map<java.lang.String,​java.lang.Object> parameters)

      • deletePersistedReport

        javax.ws.rs.core.Response deletePersistedReport​(int id)

      • listScheduledReports

        javax.ws.rs.core.Response listScheduledReports​(@Context
                                               javax.ws.rs.core.UriInfo uriInfo)

      • getSchedule

        javax.ws.rs.core.Response getSchedule​(java.lang.String triggerName)

      • updateSchedule

        javax.ws.rs.core.Response updateSchedule​(java.lang.String triggerName,
                                         java.util.Map<java.lang.String,​java.lang.Object> parameters)

      • deleteScheduledReports

        javax.ws.rs.core.Response deleteScheduledReports()

      • scheduleReport

        javax.ws.rs.core.Response scheduleReport​(java.util.Map<java.lang.String,​java.lang.Object> parameters)

      • deleteScheduledReport

        javax.ws.rs.core.Response deleteScheduledReport​(java.lang.String triggerName)

      • downloadReport

        javax.ws.rs.core.Response downloadReport​(java.lang.String format,
                                         java.lang.String locatorId)