Package org.camunda.bpm.engine.rest

Interface BatchRestService

All Known Implementing Classes:

BatchRestServiceImpl

public interface BatchRestService

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PATH

Method Summary

Modifier and Type	Method	Description
BatchResource	getBatch(String batchId)
List<BatchDto>	getBatches(jakarta.ws.rs.core.UriInfo uriInfo, Integer firstResult, Integer maxResults)
CountResultDto	getBatchesCount(jakarta.ws.rs.core.UriInfo uriInfo)
List<BatchStatisticsDto>	getStatistics(jakarta.ws.rs.core.UriInfo uriInfo, Integer firstResult, Integer maxResults)
CountResultDto	getStatisticsCount(jakarta.ws.rs.core.UriInfo uriInfo)

Field Details

PATH

static final String PATH

See Also:

• Constant Field Values

Method Details

getBatch

@Path("/{id}")
BatchResource getBatch(@PathParam("id")
 String batchId)

getBatches

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

getBatchesCount

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

getStatistics

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

getStatisticsCount

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