org.camunda.bpm.engine.rest

Interface ProcessInstanceRestService

All Known Implementing Classes:

ProcessInstanceRestServiceImpl

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	PATH

Method Summary

Modifier and Type	Method and Description
BatchDto	deleteAsync(DeleteProcessInstancesDto dto)
BatchDto	deleteAsyncHistoricQueryBased(DeleteProcessInstancesDto dto)
ProcessInstanceResource	getProcessInstance(String processInstanceId)
List<ProcessInstanceDto>	getProcessInstances(javax.ws.rs.core.UriInfo uriInfo, Integer firstResult, Integer maxResults) Exposes the ProcessInstanceQuery interface as a REST service.
CountResultDto	getProcessInstancesCount(javax.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)
void	updateSuspensionState(ProcessInstanceSuspensionStateDto dto)
BatchDto	updateSuspensionStateAsync(ProcessInstanceSuspensionStateDto dto)

Field Detail

PATH

static final String PATH

See Also:

Constant Field Values

Method Detail

getProcessInstance

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

getProcessInstances

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

Exposes the ProcessInstanceQuery interface as a REST service.

Parameters:

uriInfo -

firstResult -

maxResults -

Returns:

queryProcessInstances

@POST
 @Consumes(value="application/json")
 @Produces(value="application/json")
List<ProcessInstanceDto> queryProcessInstances(ProcessInstanceQueryDto query,
                                                                                                                               @QueryParam(value="firstResult")
                                                                                                                               Integer firstResult,
                                                                                                                               @QueryParam(value="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(value="/count")
 @Produces(value="application/json")
CountResultDto getProcessInstancesCount(@Context
                                                                                                         javax.ws.rs.core.UriInfo uriInfo)

queryProcessInstancesCount

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

updateSuspensionState

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

updateSuspensionStateAsync

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

deleteAsync

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

deleteAsyncHistoricQueryBased

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

setRetriesByProcess

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

setRetriesByProcessHistoricQueryBased

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