org.camunda.bpm.engine.rest.history

Interface HistoricCaseInstanceRestService

All Known Implementing Classes:

HistoricCaseInstanceRestServiceImpl

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	PATH

Method Summary

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

Field Detail

PATH

static final String PATH

See Also:

Constant Field Values

Method Detail

getHistoricCaseInstance

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

getHistoricCaseInstances

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

Exposes the HistoricCaseInstanceQuery interface as a REST service.

queryHistoricCaseInstances

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

getHistoricCaseInstancesCount

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

queryHistoricCaseInstancesCount

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