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

Interface HistoricCaseInstanceRestService

All Known Implementing Classes:

HistoricCaseInstanceRestServiceImpl

@Path("/case-instance")
@Produces("application/json")
public interface HistoricCaseInstanceRestService

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PATH

Method Summary

Modifier and Type	Method	Description
HistoricCaseInstanceResource	getHistoricCaseInstance(String caseInstanceId)
List<HistoricCaseInstanceDto>	getHistoricCaseInstances(jakarta.ws.rs.core.UriInfo uriInfo, Integer firstResult, Integer maxResults)	Exposes the HistoricCaseInstanceQuery interface as a REST service.
CountResultDto	getHistoricCaseInstancesCount(jakarta.ws.rs.core.UriInfo uriInfo)
List<HistoricCaseInstanceDto>	queryHistoricCaseInstances(HistoricCaseInstanceQueryDto query, Integer firstResult, Integer maxResults)
CountResultDto	queryHistoricCaseInstancesCount(HistoricCaseInstanceQueryDto query)

Field Details

PATH

static final String PATH

See Also:

• Constant Field Values

Method Details

getHistoricCaseInstance

@Path("/{id}")
HistoricCaseInstanceResource getHistoricCaseInstance(@PathParam("id")
 String caseInstanceId)

getHistoricCaseInstances

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

Exposes the HistoricCaseInstanceQuery interface as a REST service.

queryHistoricCaseInstances

@POST
@Consumes("application/json")
@Produces("application/json")
List<HistoricCaseInstanceDto> queryHistoricCaseInstances(HistoricCaseInstanceQueryDto query,
 @QueryParam("firstResult")
 Integer firstResult,
 @QueryParam("maxResults")
 Integer maxResults)

getHistoricCaseInstancesCount

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

queryHistoricCaseInstancesCount

@POST
@Path("/count")
@Consumes("application/json")
@Produces("application/json")
CountResultDto queryHistoricCaseInstancesCount(HistoricCaseInstanceQueryDto query)