com.xebialabs.deployit.engine.api

Interface ReportService

@Path(value="/report")
 @Consumes(value={"application/xml","application/json"})
 @Produces(value={"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

Modifier and Type	Method and Description
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.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.util.List<ConfigurationItemId> configurationItemIds) Find all archived Deployment Tasks, optionally filtered by parameters.
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, com.xebialabs.deployit.engine.api.dto.Paging paging, java.util.Set<java.lang.String> targets) Find all archived Control Tasks, optionally filtered by parameters.
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.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.

Method Detail

listApplications

@GET
 @Path(value="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(value="controltasks")
java.util.stream.Stream<ControlTaskReportLine> getControlTasksReport(@QueryParam(value="begin")
                                                                                                        Date begin,
                                                                                                        @QueryParam(value="end")
                                                                                                        Date end,
                                                                                                        @QueryParam(value="states")
                                                                                                        java.util.List<java.lang.String> states,
                                                                                                        @QueryParam(value="taskName")
                                                                                                        java.lang.String taskName,
                                                                                                        @QueryParam(value="fetchMode")
                                                                                                        FetchMode fetchMode,
                                                                                                        @QueryParam(value="users")
                                                                                                        java.util.List<java.lang.String> users,
                                                                                                        @QueryParam(value="order")
                                                                                                        java.util.List<com.xebialabs.deployit.engine.api.dto.Ordering> order,
                                                                                                        @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

fetchMode - toggle to fetch FULL task with blocks or just task SUMMARY

Returns:

a list of ControlTaskReportLine objects

getTaskReport

@POST
 @Path(value="tasks")
java.util.stream.Stream<DeploymentTaskReportLine> getTaskReport(@QueryParam(value="begin")
                                                                                            Date begin,
                                                                                            @QueryParam(value="end")
                                                                                            Date end,
                                                                                            @BeanParam
                                                                                            com.xebialabs.deployit.engine.api.dto.Paging paging,
                                                                                            @QueryParam(value="order")
                                                                                            java.util.List<com.xebialabs.deployit.engine.api.dto.Ordering> order,
                                                                                            @QueryParam(value="users")
                                                                                            java.util.List<java.lang.String> users,
                                                                                            @QueryParam(value="states")
                                                                                            java.util.List<java.lang.String> taskStates,
                                                                                            @QueryParam(value="types")
                                                                                            java.util.List<java.lang.String> taskTypes,
                                                                                            @QueryParam(value="fetchMode")
                                                                                            FetchMode fetchMode,
                                                                                            @QueryParam(value="taskId")
                                                                                            java.lang.String taskId,
                                                                                            @QueryParam(value="onlySuccessful")
                                                                                            boolean onlySuccessful,
                                                                                            java.util.List<ConfigurationItemId> configurationItemIds)

Find all archived Deployment Tasks, optionally filtered by parameters.

Parameters:

taskId - (Optional) filter task with exact taskId

onlySuccessful - (Optional) filter only successfully finished tasks

users - (Optional) filter tasks belonging to users

taskStates - (Optional) filter on tasks in states

taskTypes - (Optional) filter on tasks types

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

fetchMode - toggle to fetch FULL task with blocks or just task SUMMARY

configurationItemIds - filter by list of CIs - environment and application correlated to the Deployment task

Returns:

a list of DeploymentTaskReportLine objects

downloadControlTasksReport

@POST
 @Path(value="download/controltasks")
java.lang.String downloadControlTasksReport(@QueryParam(value="begin")
                                                                                        Date begin,
                                                                                        @QueryParam(value="end")
                                                                                        Date end,
                                                                                        @QueryParam(value="states")
                                                                                        java.util.List<java.lang.String> states,
                                                                                        @QueryParam(value="taskName")
                                                                                        java.lang.String taskName,
                                                                                        @QueryParam(value="users")
                                                                                        java.util.List<java.lang.String> users,
                                                                                        @QueryParam(value="order")
                                                                                        java.util.List<com.xebialabs.deployit.engine.api.dto.Ordering> order,
                                                                                        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 - Which ordering to use when listing results

targets - filter by list of target CIs

Returns:

a {java.util.String} containing CSV report

downloadTaskReport

@POST
 @Path(value="download/tasks")
java.lang.String downloadTaskReport(@QueryParam(value="begin")
                                                                         Date begin,
                                                                         @QueryParam(value="end")
                                                                         Date end,
                                                                         @QueryParam(value="order")
                                                                         java.util.List<com.xebialabs.deployit.engine.api.dto.Ordering> order,
                                                                         @QueryParam(value="users")
                                                                         java.util.List<java.lang.String> users,
                                                                         @QueryParam(value="states")
                                                                         java.util.List<java.lang.String> taskStates,
                                                                         @QueryParam(value="types")
                                                                         java.util.List<java.lang.String> taskTypes,
                                                                         @QueryParam(value="taskId")
                                                                         java.lang.String taskId,
                                                                         @QueryParam(value="onlySuccessful")
                                                                         boolean onlySuccessful,
                                                                         java.util.List<ConfigurationItemId> configurationItemIds)

Find all archived Deployment Tasks, optionally filtered by parameters.

Parameters:

taskId - (Optional) filter task with exact taskId

onlySuccessful - (Optional) filter only successfully finished tasks

users - (Optional) filter tasks belonging to users

taskStates - (Optional) filter on tasks in states

taskTypes - (Optional) filter on tasks types

begin - (Optional) filter by time interval beginning with date

end - (Optional) filter by time interval ending with date

order - Which ordering to use when listing results

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(value="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