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 final String	PATH

Method Summary

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

Field Details

PATH

static final String PATH

See Also:

• Constant Field Values

Method Details

getHistoricBatch

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

getHistoricBatches

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

getHistoricBatchesCount

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

getCleanableHistoricBatchesReport

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

getCleanableHistoricBatchesReportCount

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

setRemovalTimeAsync

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