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 final String	PATH

Method Summary

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

Field Details

PATH

static final String PATH

See Also:

• Constant Field Values

Method Details

getHistoricProcessInstance

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

getHistoricProcessInstances

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

Exposes the HistoricProcessInstanceQuery interface as a REST service.

Parameters:

uriInfo -

firstResult -

maxResults -

Returns:

queryHistoricProcessInstances

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

Parameters:

query -

firstResult -

maxResults -

Returns:

getHistoricProcessInstancesCount

@GET
@Path("/count")
@Produces("application/json")
CountResultDto getHistoricProcessInstancesCount(@Context
 jakarta.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"})
jakarta.ws.rs.core.Response getHistoricProcessInstancesReport(@Context
 jakarta.ws.rs.core.UriInfo uriInfo,
 @Context
 jakarta.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")
jakarta.ws.rs.core.Response deleteHistoricVariableInstancesByProcessInstanceId(@PathParam("id")
 String processInstanceId)