Package org.camunda.bpm.engine.rest.history

Interface HistoricBatchRestService

All Known Implementing Classes:

HistoricBatchRestServiceImpl

@Path("/batch")
public interface HistoricBatchRestService

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	PATH

Method Summary

Modifier and Type	Method	Description
java.util.List<CleanableHistoricBatchReportResultDto>	getCleanableHistoricBatchesReport(javax.ws.rs.core.UriInfo uriInfo, java.lang.Integer firstResult, java.lang.Integer maxResults)
CountResultDto	getCleanableHistoricBatchesReportCount(javax.ws.rs.core.UriInfo uriInfo)
HistoricBatchResource	getHistoricBatch(java.lang.String batchId)
java.util.List<HistoricBatchDto>	getHistoricBatches(javax.ws.rs.core.UriInfo uriInfo, java.lang.Integer firstResult, java.lang.Integer maxResults)
CountResultDto	getHistoricBatchesCount(javax.ws.rs.core.UriInfo uriInfo)
BatchDto	setRemovalTimeAsync(SetRemovalTimeToHistoricBatchesDto dto)

Field Detail

PATH

static final java.lang.String PATH

See Also:

Constant Field Values

Method Detail

getHistoricBatch

@Path("/{id}")
HistoricBatchResource getHistoricBatch(@PathParam("id")
                                       java.lang.String batchId)

getHistoricBatches

@GET
@Produces("application/json")
java.util.List<HistoricBatchDto> getHistoricBatches(@Context
                                                    javax.ws.rs.core.UriInfo uriInfo,
                                                    @QueryParam("firstResult")
                                                    java.lang.Integer firstResult,
                                                    @QueryParam("maxResults")
                                                    java.lang.Integer maxResults)

getHistoricBatchesCount

@GET
@Path("/count")
@Produces("application/json")
CountResultDto getHistoricBatchesCount(@Context
                                       javax.ws.rs.core.UriInfo uriInfo)

getCleanableHistoricBatchesReport

@GET
@Path("/cleanable-batch-report")
@Produces("application/json")
java.util.List<CleanableHistoricBatchReportResultDto> getCleanableHistoricBatchesReport(@Context
                                                                                        javax.ws.rs.core.UriInfo uriInfo,
                                                                                        @QueryParam("firstResult")
                                                                                        java.lang.Integer firstResult,
                                                                                        @QueryParam("maxResults")
                                                                                        java.lang.Integer maxResults)

getCleanableHistoricBatchesReportCount

@GET
@Path("/cleanable-batch-report/count")
@Produces("application/json")
CountResultDto getCleanableHistoricBatchesReportCount(@Context
                                                      javax.ws.rs.core.UriInfo uriInfo)

setRemovalTimeAsync

@POST
@Path("/set-removal-time")
@Consumes("application/json")
@Produces("application/json")
BatchDto setRemovalTimeAsync(SetRemovalTimeToHistoricBatchesDto dto)