org.camunda.bpm.engine.rest.history

Interface HistoricBatchRestService

All Known Implementing Classes:

HistoricBatchRestServiceImpl

@Path(value="/batch")
public interface HistoricBatchRestService

Field Summary

Fields

Modifier and Type	Field and Description
static String	PATH

Method Summary

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

Field Detail

PATH

static final String PATH

See Also:

Constant Field Values

Method Detail

getHistoricBatch

@Path(value="/{id}")
HistoricBatchResource getHistoricBatch(@PathParam(value="id")
                                                            String batchId)

getHistoricBatches

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

getHistoricBatchesCount

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

getCleanableHistoricBatchesReport

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

getCleanableHistoricBatchesReportCount

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

setRemovalTimeAsync

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