Package com.xebialabs.deployit.engine.api

Interface ReportService

  • @Path("/report")
@Consumes({"application/xml","application/json"})
@Produces({"application/xml","application/json"})
public interface ReportService
    Retrieves reports for Deployment or Control Tasks A User must have a REPORT_VIEW permission to be able to run these operations. A User must have at least READ permission on the environment or application for Deployment Task report to contain data for them. A User must have at least CONTROLTASK_EXECUTE permission on target CI for Control Task report to contain data for them.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String downloadAuditReport()
      Export audit report containing global and folder permissions of roles
      java.lang.String downloadAuditReport​(java.util.List<java.lang.String> folders)
      Export audit report containing global and folder permissions of roles
      java.lang.String downloadControlTasksReport​(Date begin, Date end, java.util.List<java.lang.String> states, java.lang.String taskName, java.util.List<java.lang.String> users, java.util.List<com.xebialabs.deployit.engine.api.dto.Ordering> order, java.lang.String workerName, java.lang.String taskId, java.util.Set<java.lang.String> targets)
      Find all archived Control Tasks, optionally filtered by parameters.
      java.lang.String downloadTaskReport​(Date begin, Date end, java.util.List<com.xebialabs.deployit.engine.api.dto.Ordering> order, java.util.List<java.lang.String> users, java.util.List<java.lang.String> taskStates, java.util.List<java.lang.String> taskTypes, java.lang.String taskId, boolean onlySuccessful, java.lang.String workerName, java.util.List<ConfigurationItemId> configurationItemIds)
      Find all archived Deployment Tasks, optionally filtered by parameters.
      java.util.List<AppEnvStatusReport> getAppEnvStatus​(Date begin, Date end)
      Fetch number of deployments per application and environment.
      java.util.stream.Stream<ControlTaskReportLine> getControlTasksReport​(Date begin, Date end, java.util.List<java.lang.String> states, java.lang.String taskName, FetchMode fetchMode, java.util.List<java.lang.String> users, java.util.List<com.xebialabs.deployit.engine.api.dto.Ordering> order, java.lang.String workerName, java.lang.String taskId, com.xebialabs.deployit.engine.api.dto.Paging paging, java.util.Set<java.lang.String> targets)
      Find all archived Control Tasks, optionally filtered by parameters.
      DeploymentsStatusOverview getStatusOverview​(Date begin, Date end)
      Fetch overall number of deployments per deployment state.
      java.util.stream.Stream<DeploymentTaskReportLine> getTaskReport​(Date begin, Date end, com.xebialabs.deployit.engine.api.dto.Paging paging, java.util.List<com.xebialabs.deployit.engine.api.dto.Ordering> order, java.util.List<java.lang.String> users, java.util.List<java.lang.String> taskStates, java.util.List<java.lang.String> taskTypes, FetchMode fetchMode, java.lang.String taskId, boolean onlySuccessful, java.lang.String workerName, java.util.List<ConfigurationItemId> configurationItemIds)
      Find all archived Deployment Tasks, optionally filtered by parameters.
      java.util.List<ConfigurationItemId> listApplications()
      Find all Application CIs availble in reporting for given user This will include both names of existing CIs user has permissions for and a list of CIs that are existing in reports but are deleted or renamed.
      java.util.List<ConfigurationItemId> listEnvironments()
      Find all Environment CIs availble in reporting for given user.
      java.util.stream.Stream<com.xebialabs.deployit.engine.api.dto.AuditPreviewRow> previewAuditReport​(java.util.List<java.lang.String> folders, java.util.List<com.xebialabs.deployit.engine.api.dto.Ordering> order, com.xebialabs.deployit.engine.api.dto.Paging paging)
      Generates preview audit report for local and global permissions.
      java.util.stream.Stream<TaskWithBlock> queryByArchivedDate​(Date begin, Date end, com.xebialabs.deployit.engine.api.dto.Paging paging, java.lang.String order, FetchMode fetchMode, TaskKind taskType)
      Find all archived Tasks by archived date, optionally filtered by parameters.

    • Method Detail

      • listApplications

        @GET
@Path("applications")
java.util.List<ConfigurationItemId> listApplications()
        Find all Application CIs availble in reporting for given user This will include both names of existing CIs user has permissions for and a list of CIs that are existing in reports but are deleted or renamed. Deleted CIs are visible only to user with ADMIN rights.
        Returns:
        a list of ConfigurationItemId objects

      • getControlTasksReport

        @POST
@Path("controltasks")
java.util.stream.Stream<ControlTaskReportLine> getControlTasksReport​(@QueryParam("begin")
                                                                     Date begin,
                                                                     @QueryParam("end")
                                                                     Date end,
                                                                     @QueryParam("states")
                                                                     java.util.List<java.lang.String> states,
                                                                     @QueryParam("taskName")
                                                                     java.lang.String taskName,
                                                                     @QueryParam("fetchMode")
                                                                     FetchMode fetchMode,
                                                                     @QueryParam("users")
                                                                     java.util.List<java.lang.String> users,
                                                                     @QueryParam("order")
                                                                     java.util.List<com.xebialabs.deployit.engine.api.dto.Ordering> order,
                                                                     @QueryParam("worker")
                                                                     java.lang.String workerName,
                                                                     @QueryParam("taskId")
                                                                     java.lang.String taskId,
                                                                     @BeanParam
                                                                     com.xebialabs.deployit.engine.api.dto.Paging paging,
                                                                     java.util.Set<java.lang.String> targets)
        Find all archived Control Tasks, optionally filtered by parameters.
        Parameters:
        users - (Optional) filter tasks belonging to users
        states - (Optional) filter on tasks in states
        taskName - (Optional) filter on task name
        begin - (Optional) filter by time interval beginning with date
        end - (Optional) filter by time interval ending with date
        paging - Which page and how many results per page to retrieve
        order - Which ordering to use when listing results
        targets - filter by list of target CIs
        workerName - (Optional) filter only specified workers
        fetchMode - toggle to fetch FULL task with blocks or just task SUMMARY
        taskId - (Optional) filter by task id
        Returns:
        a list of ControlTaskReportLine objects

      • getTaskReport

        @POST
@Path("tasks")
java.util.stream.Stream<DeploymentTaskReportLine> getTaskReport​(@QueryParam("begin")
                                                                Date begin,
                                                                @QueryParam("end")
                                                                Date end,
                                                                @BeanParam
                                                                com.xebialabs.deployit.engine.api.dto.Paging paging,
                                                                @QueryParam("order")
                                                                java.util.List<com.xebialabs.deployit.engine.api.dto.Ordering> order,
                                                                @QueryParam("users")
                                                                java.util.List<java.lang.String> users,
                                                                @QueryParam("states")
                                                                java.util.List<java.lang.String> taskStates,
                                                                @QueryParam("types")
                                                                java.util.List<java.lang.String> taskTypes,
                                                                @QueryParam("fetchMode")
                                                                FetchMode fetchMode,
                                                                @QueryParam("taskId")
                                                                java.lang.String taskId,
                                                                @QueryParam("onlySuccessful")
                                                                boolean onlySuccessful,
                                                                @QueryParam("worker")
                                                                java.lang.String workerName,
                                                                java.util.List<ConfigurationItemId> configurationItemIds)
        Find all archived Deployment Tasks, optionally filtered by parameters.
        Parameters:
        taskId - (Optional) filter task with exact taskId
        onlySuccessful - Deprecated use taskStates instead
        users - (Optional) filter tasks belonging to users
        taskStates - (Optional) filter on tasks in states
        taskTypes - (Optional) filter on tasks types
        begin - filter by time interval beginning with date
        end - filter by time interval ending with date
        paging - (Optional) Which page and how many results per page to retrieve
        order - (Optional) Which ordering to use when listing results
        fetchMode - (Optional) toggle to fetch FULL task with blocks or just task SUMMARY
        workerName - (Optional) filter only specified workers
        configurationItemIds - filter by list of CIs - environment and application correlated to the Deployment task
        Returns:
        a list of DeploymentTaskReportLine objects

      • downloadControlTasksReport

        @POST
@Path("download/controltasks")
java.lang.String downloadControlTasksReport​(@QueryParam("begin")
                                            Date begin,
                                            @QueryParam("end")
                                            Date end,
                                            @QueryParam("states")
                                            java.util.List<java.lang.String> states,
                                            @QueryParam("taskName")
                                            java.lang.String taskName,
                                            @QueryParam("users")
                                            java.util.List<java.lang.String> users,
                                            @QueryParam("order")
                                            java.util.List<com.xebialabs.deployit.engine.api.dto.Ordering> order,
                                            @QueryParam("worker")
                                            java.lang.String workerName,
                                            @QueryParam("taskId")
                                            java.lang.String taskId,
                                            java.util.Set<java.lang.String> targets)
        Find all archived Control Tasks, optionally filtered by parameters.
        Parameters:
        users - (Optional) filter tasks belonging to users
        states - (Optional) filter on tasks in states
        taskName - (Optional) filter on task name
        begin - (Optional) filter by time interval beginning with date
        end - (Optional) filter by time interval ending with date
        order - (Optional) Which ordering to use when listing results
        workerName - (Optional) filter only specified workers
        taskId - (Optional) filter by task id
        targets - filter by list of target CIs
        Returns:
        a {java.util.String} containing CSV report

      • downloadTaskReport

        @POST
@Path("download/tasks")
java.lang.String downloadTaskReport​(@QueryParam("begin")
                                    Date begin,
                                    @QueryParam("end")
                                    Date end,
                                    @QueryParam("order")
                                    java.util.List<com.xebialabs.deployit.engine.api.dto.Ordering> order,
                                    @QueryParam("users")
                                    java.util.List<java.lang.String> users,
                                    @QueryParam("states")
                                    java.util.List<java.lang.String> taskStates,
                                    @QueryParam("types")
                                    java.util.List<java.lang.String> taskTypes,
                                    @QueryParam("taskId")
                                    java.lang.String taskId,
                                    @QueryParam("onlySuccessful")
                                    boolean onlySuccessful,
                                    @QueryParam("worker")
                                    java.lang.String workerName,
                                    java.util.List<ConfigurationItemId> configurationItemIds)
        Find all archived Deployment Tasks, optionally filtered by parameters.
        Parameters:
        begin - filter by time interval beginning with date
        end - filter by time interval ending with date
        order - (Optional) Which ordering to use when listing results
        users - (Optional) filter tasks belonging to users
        taskStates - (Optional) filter on tasks in states
        taskTypes - (Optional) filter on tasks types
        taskId - (Optional) filter task with exact taskId
        onlySuccessful - Deprecated use taskStates instead
        workerName - (Optional) filter only specified workers
        configurationItemIds - filter by list of CIs - environment and application correlated to the Deployment task
        Returns:
        a {java.util.String} containing CSV report

      • listEnvironments

        @GET
@Path("environments")
java.util.List<ConfigurationItemId> listEnvironments()
        Find all Environment CIs availble in reporting for given user. This will include both names of existing CIs user has permissions for and a list of CIs that are existing in reports but are deleted or renamed. Deleted CIs are visible only to user with ADMIN rights.
        Returns:
        a list of ConfigurationItemId objects

      • downloadAuditReport

        @POST
@Path("download/audit")
java.lang.String downloadAuditReport()
        Export audit report containing global and folder permissions of roles
        Returns:
        a {java.util.String} containing audit report

      • downloadAuditReport

        @POST
@Path("download/audit/v2")
java.lang.String downloadAuditReport​(@QueryParam("folders")
                                     java.util.List<java.lang.String> folders)
        Export audit report containing global and folder permissions of roles
        Parameters:
        folders - Which folders in audit report
        Returns:
        a {java.util.String} containing audit report

      • previewAuditReport

        @POST
@Path("preview/audit")
java.util.stream.Stream<com.xebialabs.deployit.engine.api.dto.AuditPreviewRow> previewAuditReport​(@QueryParam("folders")
                                                                                                  java.util.List<java.lang.String> folders,
                                                                                                  @QueryParam("order")
                                                                                                  java.util.List<com.xebialabs.deployit.engine.api.dto.Ordering> order,
                                                                                                  @BeanParam
                                                                                                  com.xebialabs.deployit.engine.api.dto.Paging paging)
        Generates preview audit report for local and global permissions.
        Parameters:
        folders - Which folders in audit report
        order - Which ordering to use when listing results
        paging - Which page and how many results per page to retrieve
        Returns:
        a list of AuditPreviewRow objects

      • getStatusOverview

        @GET
@Path("status-overview")
DeploymentsStatusOverview getStatusOverview​(@QueryParam("begin")
                                            Date begin,
                                            @QueryParam("end")
                                            Date end)
        Fetch overall number of deployments per deployment state.
        Parameters:
        begin - filter by time interval beginning with date
        end - filter by time interval ending with date
        Returns:
        a DeploymentsStatusOverview object

      • getAppEnvStatus

        @GET
@Path("app-env-status")
java.util.List<AppEnvStatusReport> getAppEnvStatus​(@QueryParam("begin")
                                                   Date begin,
                                                   @QueryParam("end")
                                                   Date end)
        Fetch number of deployments per application and environment.
        Parameters:
        begin - filter by time interval beginning with date
        end - filter by time interval ending with date
        Returns:
        a list of AppEnvStatusReport objects

      • queryByArchivedDate

        @GET
@Path("tasks/query-by-archived-date")
java.util.stream.Stream<TaskWithBlock> queryByArchivedDate​(@QueryParam("begin")
                                                           Date begin,
                                                           @QueryParam("end")
                                                           Date end,
                                                           @BeanParam
                                                           com.xebialabs.deployit.engine.api.dto.Paging paging,
                                                           @QueryParam("order")
                                                           java.lang.String order,
                                                           @QueryParam("fetchMode")
                                                           FetchMode fetchMode,
                                                           @QueryParam("taskType")
                                                           TaskKind taskType)
        Find all archived Tasks by archived date, optionally filtered by parameters.
        Parameters:
        begin - filter by time interval beginning with date
        end - filter by time interval ending with date
        order - (Optional) Which ordering to use on archived date when listing results
        paging - (Optional) Which page and how many results per page to retrieve
        fetchMode - (Optional) toggle to fetch FULL task with blocks or just task SUMMARY
        taskType - (Optional) Filter by task type. DEPLOYMENT or CONTROL_TASK
        Returns:
        a list of tasks. response header X-Total-Count determines the total number of tasks.
        Permission:
        report#view