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 java.lang.String	PATH

Method Summary

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

Field Detail

PATH

static final java.lang.String PATH

See Also:

Constant Field Values

Method Detail

getHistoricCaseInstance

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

getHistoricCaseInstances

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

Exposes the HistoricCaseInstanceQuery interface as a REST service.

queryHistoricCaseInstances

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

getHistoricCaseInstancesCount

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

queryHistoricCaseInstancesCount

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