org.camunda.bpm.engine.rest.history

Interface HistoricProcessInstanceRestService

All Known Implementing Classes:

HistoricProcessInstanceRestServiceImpl

@Path(value="/process-instance")
 @Produces(value="application/json")
public interface HistoricProcessInstanceRestService

Field Summary

Fields

Modifier and Type	Field and Description
static String	PATH

Method Summary

Modifier and Type	Method and Description
BatchDto	deleteAsync(DeleteHistoricProcessInstancesDto dto)
javax.ws.rs.core.Response	deleteHistoricVariableInstancesByProcessInstanceId(String processInstanceId)
HistoricProcessInstanceResource	getHistoricProcessInstance(String processInstanceId)
List<HistoricProcessInstanceDto>	getHistoricProcessInstances(javax.ws.rs.core.UriInfo uriInfo, Integer firstResult, Integer maxResults) Exposes the HistoricProcessInstanceQuery interface as a REST service.
CountResultDto	getHistoricProcessInstancesCount(javax.ws.rs.core.UriInfo uriInfo)
javax.ws.rs.core.Response	getHistoricProcessInstancesReport(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.Request request)
List<HistoricProcessInstanceDto>	queryHistoricProcessInstances(HistoricProcessInstanceQueryDto query, Integer firstResult, Integer maxResults)
CountResultDto	queryHistoricProcessInstancesCount(HistoricProcessInstanceQueryDto query)
BatchDto	setRemovalTimeAsync(SetRemovalTimeToHistoricProcessInstancesDto dto)

Field Detail

PATH

static final String PATH

See Also:

Constant Field Values

Method Detail

getHistoricProcessInstance

@Path(value="/{id}")
HistoricProcessInstanceResource getHistoricProcessInstance(@PathParam(value="id")
                                                                                String processInstanceId)

getHistoricProcessInstances

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

Exposes the HistoricProcessInstanceQuery interface as a REST service.

Parameters:

uriInfo -

firstResult -

maxResults -

Returns:

queryHistoricProcessInstances

@POST
 @Consumes(value="application/json")
 @Produces(value="application/json")
List<HistoricProcessInstanceDto> queryHistoricProcessInstances(HistoricProcessInstanceQueryDto query,
                                                                                                                                               @QueryParam(value="firstResult")
                                                                                                                                               Integer firstResult,
                                                                                                                                               @QueryParam(value="maxResults")
                                                                                                                                               Integer maxResults)

Parameters:

query -

firstResult -

maxResults -

Returns:

getHistoricProcessInstancesCount

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

queryHistoricProcessInstancesCount

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

getHistoricProcessInstancesReport

@GET
 @Path(value="/report")
 @Produces(value={"application/json","text/csv","application/csv"})
javax.ws.rs.core.Response getHistoricProcessInstancesReport(@Context
                                                                                                                                                             javax.ws.rs.core.UriInfo uriInfo,
                                                                                                                                                             @Context
                                                                                                                                                             javax.ws.rs.core.Request request)

deleteAsync

@POST
 @Path(value="/delete")
 @Consumes(value="application/json")
 @Produces(value="application/json")
BatchDto deleteAsync(DeleteHistoricProcessInstancesDto dto)

setRemovalTimeAsync

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

deleteHistoricVariableInstancesByProcessInstanceId

@DELETE
 @Path(value="/{id}/variable-instances")
javax.ws.rs.core.Response deleteHistoricVariableInstancesByProcessInstanceId(@PathParam(value="id")
                                                                                                                              String processInstanceId)