Package org.camunda.bpm.engine.rest

Interface ProcessInstanceRestService

All Known Implementing Classes:

ProcessInstanceRestServiceImpl

@Produces("application/json")
public interface ProcessInstanceRestService

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PATH

Method Summary

Modifier and Type	Method	Description
BatchDto	correlateMessageAsync(CorrelationMessageAsyncDto correlationMessageAsyncDto)
BatchDto	deleteAsync(DeleteProcessInstancesDto dto)
BatchDto	deleteAsyncHistoricQueryBased(DeleteProcessInstancesDto dto)
ProcessInstanceResource	getProcessInstance(String processInstanceId)
List<ProcessInstanceDto>	getProcessInstances(jakarta.ws.rs.core.UriInfo uriInfo, Integer firstResult, Integer maxResults)	Exposes the ProcessInstanceQuery interface as a REST service.
CountResultDto	getProcessInstancesCount(jakarta.ws.rs.core.UriInfo uriInfo)
List<ProcessInstanceDto>	queryProcessInstances(ProcessInstanceQueryDto query, Integer firstResult, Integer maxResults)	Expects the same parameters as getProcessInstances(UriInfo, Integer, Integer) (as a JSON message body) and allows for any number of variable checks.
CountResultDto	queryProcessInstancesCount(ProcessInstanceQueryDto query)
BatchDto	setRetriesByProcess(SetJobRetriesByProcessDto setJobRetriesDto)
BatchDto	setRetriesByProcessHistoricQueryBased(SetJobRetriesByProcessDto setJobRetriesDto)
BatchDto	setVariablesAsync(SetVariablesAsyncDto setVariablesAsyncDto)
void	updateSuspensionState(ProcessInstanceSuspensionStateDto dto)
BatchDto	updateSuspensionStateAsync(ProcessInstanceSuspensionStateAsyncDto dto)

Field Details

PATH

static final String PATH

See Also:

• Constant Field Values

Method Details

getProcessInstance

@Path("/{id}")
ProcessInstanceResource getProcessInstance(@PathParam("id")
 String processInstanceId)

getProcessInstances

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

Exposes the ProcessInstanceQuery interface as a REST service.

Parameters:

uriInfo -

firstResult -

maxResults -

Returns:

queryProcessInstances

@POST
@Consumes("application/json")
@Produces("application/json")
List<ProcessInstanceDto> queryProcessInstances(ProcessInstanceQueryDto query,
 @QueryParam("firstResult")
 Integer firstResult,
 @QueryParam("maxResults")
 Integer maxResults)

Expects the same parameters as getProcessInstances(UriInfo, Integer, Integer) (as a JSON message body) and allows for any number of variable checks.

Parameters:

query -

firstResult -

maxResults -

Returns:

getProcessInstancesCount

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

queryProcessInstancesCount

@POST
@Path("/count")
@Consumes("application/json")
@Produces("application/json")
CountResultDto queryProcessInstancesCount(ProcessInstanceQueryDto query)

updateSuspensionState

@PUT
@Path("/suspended")
@Consumes("application/json")
void updateSuspensionState(ProcessInstanceSuspensionStateDto dto)

updateSuspensionStateAsync

@POST
@Path("/suspended-async")
@Consumes("application/json")
@Produces("application/json")
BatchDto updateSuspensionStateAsync(ProcessInstanceSuspensionStateAsyncDto dto)

deleteAsync

@POST
@Path("/delete")
@Consumes("application/json")
@Produces("application/json")
BatchDto deleteAsync(DeleteProcessInstancesDto dto)

deleteAsyncHistoricQueryBased

@POST
@Path("/delete-historic-query-based")
@Consumes("application/json")
@Produces("application/json")
BatchDto deleteAsyncHistoricQueryBased(DeleteProcessInstancesDto dto)

setRetriesByProcess

@POST
@Path("/job-retries")
@Consumes("application/json")
@Produces("application/json")
BatchDto setRetriesByProcess(SetJobRetriesByProcessDto setJobRetriesDto)

setRetriesByProcessHistoricQueryBased

@POST
@Path("/job-retries-historic-query-based")
@Consumes("application/json")
@Produces("application/json")
BatchDto setRetriesByProcessHistoricQueryBased(SetJobRetriesByProcessDto setJobRetriesDto)

setVariablesAsync

@POST
@Path("/variables-async")
@Consumes("application/json")
@Produces("application/json")
BatchDto setVariablesAsync(SetVariablesAsyncDto setVariablesAsyncDto)

correlateMessageAsync

@POST
@Path("/message-async")
@Consumes("application/json")
@Produces("application/json")
BatchDto correlateMessageAsync(CorrelationMessageAsyncDto correlationMessageAsyncDto)