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

Interface HistoricProcessInstanceRestService

All Known Implementing Classes:

HistoricProcessInstanceRestServiceImpl

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

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	PATH

Method Summary

Modifier and Type	Method	Description
BatchDto	deleteAsync(DeleteHistoricProcessInstancesDto dto)
javax.ws.rs.core.Response	deleteHistoricVariableInstancesByProcessInstanceId(java.lang.String processInstanceId)
HistoricProcessInstanceResource	getHistoricProcessInstance(java.lang.String processInstanceId)
java.util.List<HistoricProcessInstanceDto>	getHistoricProcessInstances(javax.ws.rs.core.UriInfo uriInfo, java.lang.Integer firstResult, java.lang.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)
java.util.List<HistoricProcessInstanceDto>	queryHistoricProcessInstances(HistoricProcessInstanceQueryDto query, java.lang.Integer firstResult, java.lang.Integer maxResults)
CountResultDto	queryHistoricProcessInstancesCount(HistoricProcessInstanceQueryDto query)
BatchDto	setRemovalTimeAsync(SetRemovalTimeToHistoricProcessInstancesDto dto)

Field Detail

PATH

static final java.lang.String PATH

See Also:

Constant Field Values

Method Detail

getHistoricProcessInstance

@Path("/{id}")
HistoricProcessInstanceResource getHistoricProcessInstance(@PathParam("id")
                                                           java.lang.String processInstanceId)

getHistoricProcessInstances

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

Exposes the HistoricProcessInstanceQuery interface as a REST service.

Parameters:

uriInfo -

firstResult -

maxResults -

Returns:

queryHistoricProcessInstances

@POST
@Consumes("application/json")
@Produces("application/json")
java.util.List<HistoricProcessInstanceDto> queryHistoricProcessInstances(HistoricProcessInstanceQueryDto query,
                                                                         @QueryParam("firstResult")
                                                                         java.lang.Integer firstResult,
                                                                         @QueryParam("maxResults")
                                                                         java.lang.Integer maxResults)

Parameters:

query -

firstResult -

maxResults -

Returns:

getHistoricProcessInstancesCount

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

queryHistoricProcessInstancesCount

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

getHistoricProcessInstancesReport

@GET
@Path("/report")
@Produces({"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("/delete")
@Consumes("application/json")
@Produces("application/json")
BatchDto deleteAsync(DeleteHistoricProcessInstancesDto dto)

setRemovalTimeAsync

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

deleteHistoricVariableInstancesByProcessInstanceId

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