org.apache.syncope.common.rest.api.service

Interface ReportService

All Superinterfaces:

ExecutableService, JAXRSService

All Known Implementing Classes:

ReportServiceImpl

@Path(value="reports")
public interface ReportService
extends ExecutableService

REST operations for reports.

Field Summary

Fields inherited from interface org.apache.syncope.common.rest.api.service.JAXRSService

CRLF, DOUBLE_DASH, PARAM_ANYTYPE_KIND, PARAM_ANYTYPEKEY, PARAM_CONNID_PAGED_RESULTS_COOKIE, PARAM_DETAILS, PARAM_ENTITY_KEY, PARAM_FIQL, PARAM_MAX, PARAM_NOTIFICATION, PARAM_ORDERBY, PARAM_PAGE, PARAM_REALM, PARAM_RESOURCE, PARAM_SIZE, PARAM_USER

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	create(@NotNull ReportTO reportTO) Creates a new report.
void	delete(@NotNull String key) Deletes report with matching key.
javax.ws.rs.core.Response	exportExecutionResult(@NotNull String executionKey, ReportExecExportFormat fmt) Exports the report execution with matching key in the requested format.
List<ReportTO>	list() Returns a list of all existing reports.
ReportTO	read(@NotNull String key) Returns report with matching key.
void	update(@NotNull ReportTO reportTO) Updates report with matching key.

Methods inherited from interface org.apache.syncope.common.rest.api.service.ExecutableService

actionJob, deleteExecution, deleteExecutions, execute, getJob, listExecutions, listJobs, listRecentExecutions

Method Detail

read

@GET
 @Path(value="{key}")
 @Produces(value={"application/json","application/yaml","application/xml"})
ReportTO read(@NotNull @PathParam(value="key")
                                                                                                                     @NotNull String key)

Returns report with matching key.

Parameters:

key - key of report to be read

Returns:

report with matching key

list

@GET
 @Produces(value={"application/json","application/yaml","application/xml"})
List<ReportTO> list()

Returns a list of all existing reports.

Returns:

paged list of existing reports matching the given query

create

@POST
 @Consumes(value={"application/json","application/yaml","application/xml"})
 @Produces(value={"application/json","application/yaml","application/xml"})
javax.ws.rs.core.Response create(@NotNull
                                                                                                                                                                                               @NotNull ReportTO reportTO)

Creates a new report.

Parameters:

reportTO - report to be created

Returns:

Response object featuring Location header of created report

update

@PUT
 @Path(value="{key}")
 @Consumes(value={"application/json","application/yaml","application/xml"})
 @Produces(value={"application/json","application/yaml","application/xml"})
void update(@NotNull
                                                                                                                                                                                               @NotNull ReportTO reportTO)

Updates report with matching key.

Parameters:

reportTO - report to be stored

delete

@DELETE
 @Path(value="{key}")
 @Produces(value={"application/json","application/yaml","application/xml"})
void delete(@NotNull @PathParam(value="key")
                                                                                                                      @NotNull String key)

Deletes report with matching key.

Parameters:

key - Deletes report with matching key

exportExecutionResult

@GET
 @Path(value="executions/{executionKey}/stream")
 @Consumes(value={"application/json","application/yaml","application/xml"})
javax.ws.rs.core.Response exportExecutionResult(@NotNull @PathParam(value="executionKey")
                                                                                                                                                                                  @NotNull String executionKey,
                                                                                                                                                                                  @QueryParam(value="format")
                                                                                                                                                                                  ReportExecExportFormat fmt)

Exports the report execution with matching key in the requested format.

Parameters:

executionKey - key of execution report to be selected

fmt - file-format selection

Returns:

a stream for content download