Package org.camunda.bpm.cockpit.impl.plugin.resources

Class ProcessInstanceRestService

java.lang.Object

org.camunda.bpm.webapp.plugin.resource.AbstractAppPluginResource<CockpitPlugin>

org.camunda.bpm.cockpit.plugin.resource.AbstractCockpitPluginResource

org.camunda.bpm.cockpit.plugin.resource.AbstractPluginResource

org.camunda.bpm.cockpit.impl.plugin.resources.ProcessInstanceRestService

public class ProcessInstanceRestService
extends AbstractPluginResource

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	ProcessInstanceRestService.QueryProcessInstancesCmd
protected class	ProcessInstanceRestService.QueryProcessInstancesCountCmd

Field Summary

Fields

Modifier and Type	Field	Description
protected com.fasterxml.jackson.databind.ObjectMapper	objectMapper
static final String	PATH

Fields inherited from class org.camunda.bpm.webapp.plugin.resource.AbstractAppPluginResource

engineName, runtimeDelegate

Constructor Summary

Constructors

Constructor	Description
ProcessInstanceRestService(String engineName)

Method Summary

Modifier and Type	Method	Description
protected void	configureExecutionQuery(ProcessInstanceQueryDto query)
ProcessInstanceResource	getProcessInstance(String id)
List<ProcessInstanceDto>	getProcessInstances(jakarta.ws.rs.core.UriInfo uriInfo, Integer firstResult, Integer maxResults)
CountResultDto	getProcessInstancesCount(jakarta.ws.rs.core.UriInfo uriInfo)
protected void	injectObjectMapper(ProcessInstanceQueryDto queryParameter)
List<ProcessInstanceDto>	queryProcessInstances(ProcessInstanceQueryDto queryParameter, Integer firstResult, Integer maxResults)
CountResultDto	queryProcessInstancesCount(ProcessInstanceQueryDto queryParameter)
void	setObjectMapper(com.fasterxml.jackson.databind.ObjectMapper objectMapper)

Methods inherited from class org.camunda.bpm.cockpit.plugin.resource.AbstractCockpitPluginResource

addPermissionCheck, configureAuthorizationCheck, configureTenantCheck, getCommandExecutor, getCurrentAuthentication, getQueryService, isAuthorizationEnabled, isCamundaAdmin, isPermissionDisabled, isTenantCheckEnabled

Methods inherited from class org.camunda.bpm.webapp.plugin.resource.AbstractAppPluginResource

getProcessEngine

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

PATH

public static final String PATH

See Also:

• Constant Field Values

objectMapper

protected com.fasterxml.jackson.databind.ObjectMapper objectMapper

Constructor Details

ProcessInstanceRestService

public ProcessInstanceRestService(String engineName)

Method Details

getProcessInstance

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

getProcessInstances

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

queryProcessInstances

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

getProcessInstancesCount

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

queryProcessInstancesCount

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

configureExecutionQuery

protected void configureExecutionQuery(ProcessInstanceQueryDto query)

injectObjectMapper

protected void injectObjectMapper(ProcessInstanceQueryDto queryParameter)

setObjectMapper

public void setObjectMapper(com.fasterxml.jackson.databind.ObjectMapper objectMapper)