org.flowable.ui.admin.rest.client

Class ProcessInstanceClientResource

java.lang.Object

org.flowable.ui.admin.rest.client.AbstractClientResource

org.flowable.ui.admin.rest.client.ProcessInstanceClientResource

@RestController
public class ProcessInstanceClientResource
extends AbstractClientResource

REST controller for managing the current user's account.

Field Summary

Fields

Modifier and Type	Field and Description
protected ProcessInstanceService	clientService

Fields inherited from class org.flowable.ui.admin.rest.client.AbstractClientResource

configRepository

Constructor Summary

Constructors

Constructor and Description
ProcessInstanceClientResource()

Method Summary

Modifier and Type	Method and Description
void	changeActivityState(String processInstanceId, com.fasterxml.jackson.databind.JsonNode changeStateBody)
void	createVariable(String processInstanceId, com.fasterxml.jackson.databind.node.ObjectNode body)
void	deleteVariable(String processInstanceId, String variableName)
void	executeAction(String processInstanceId, com.fasterxml.jackson.databind.JsonNode actionBody)
com.fasterxml.jackson.databind.JsonNode	getDecisionExecutions(String processInstanceId)
com.fasterxml.jackson.databind.JsonNode	getJobs(String processInstanceId)
com.fasterxml.jackson.databind.JsonNode	getProcessInstance(String processInstanceId, boolean runtime)
com.fasterxml.jackson.databind.JsonNode	getSubProcesses(String processInstanceId)
com.fasterxml.jackson.databind.JsonNode	getSubtasks(String processInstanceId)
com.fasterxml.jackson.databind.JsonNode	getVariables(String processInstanceId)
void	migrateProcessInstance(String processInstanceId, String migrationDocument)
void	updateVariable(String processInstanceId, String variableName, com.fasterxml.jackson.databind.node.ObjectNode body)

Methods inherited from class org.flowable.ui.admin.rest.client.AbstractClientResource

getRequestParametersWithoutServerId, retrieveServerConfig

Methods inherited from class java.lang.Object

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

Field Detail

clientService

@Autowired
protected ProcessInstanceService clientService

Constructor Detail

ProcessInstanceClientResource

public ProcessInstanceClientResource()

Method Detail

getProcessInstance

@GetMapping(value="/rest/admin/process-instances/{processInstanceId}",
            produces="application/json")
public com.fasterxml.jackson.databind.JsonNode getProcessInstance(@PathVariable
                                                                                                                                                                                  String processInstanceId,
                                                                                                                                                                                  @RequestParam(required=false,defaultValue="false")
                                                                                                                                                                                  boolean runtime)
                                                                                                                                                                           throws org.flowable.ui.common.service.exception.BadRequestException

Throws:

org.flowable.ui.common.service.exception.BadRequestException

getSubtasks

@GetMapping(value="/rest/admin/process-instances/{processInstanceId}/tasks")
public com.fasterxml.jackson.databind.JsonNode getSubtasks(@PathVariable
                                                                                                                                        String processInstanceId)
                                                                                                                                 throws org.flowable.ui.common.service.exception.BadRequestException

Throws:

org.flowable.ui.common.service.exception.BadRequestException

getVariables

@GetMapping(value="/rest/admin/process-instances/{processInstanceId}/variables")
public com.fasterxml.jackson.databind.JsonNode getVariables(@PathVariable
                                                                                                                                             String processInstanceId)
                                                                                                                                      throws org.flowable.ui.common.service.exception.BadRequestException

Throws:

org.flowable.ui.common.service.exception.BadRequestException

updateVariable

@PutMapping(value="/rest/admin/process-instances/{processInstanceId}/variables/{variableName}")
 @ResponseStatus(value=OK)
public void updateVariable(@PathVariable
                                                                                                                                                      String processInstanceId,
                                                                                                                                                      @PathVariable
                                                                                                                                                      String variableName,
                                                                                                                                                      @RequestBody
                                                                                                                                                      com.fasterxml.jackson.databind.node.ObjectNode body)
                                                                                                                                               throws org.flowable.ui.common.service.exception.BadRequestException

Throws:

org.flowable.ui.common.service.exception.BadRequestException

createVariable

@PostMapping(value="/rest/admin/process-instances/{processInstanceId}/variables")
 @ResponseStatus(value=OK)
public void createVariable(@PathVariable
                                                                                                                                        String processInstanceId,
                                                                                                                                        @RequestBody
                                                                                                                                        com.fasterxml.jackson.databind.node.ObjectNode body)
                                                                                                                                 throws org.flowable.ui.common.service.exception.BadRequestException

Throws:

org.flowable.ui.common.service.exception.BadRequestException

deleteVariable

@DeleteMapping(value="/rest/admin/process-instances/{processInstanceId}/variables/{variableName}")
 @ResponseStatus(value=OK)
public void deleteVariable(@PathVariable
                                                                                                                                                         String processInstanceId,
                                                                                                                                                         @PathVariable
                                                                                                                                                         String variableName)
                                                                                                                                                  throws org.flowable.ui.common.service.exception.BadRequestException

Throws:

org.flowable.ui.common.service.exception.BadRequestException

getSubProcesses

@GetMapping(value="/rest/admin/process-instances/{processInstanceId}/subprocesses")
public com.fasterxml.jackson.databind.JsonNode getSubProcesses(@PathVariable
                                                                                                                                                   String processInstanceId)
                                                                                                                                            throws org.flowable.ui.common.service.exception.BadRequestException

Throws:

org.flowable.ui.common.service.exception.BadRequestException

getJobs

@GetMapping(value="/rest/admin/process-instances/{processInstanceId}/jobs")
public com.fasterxml.jackson.databind.JsonNode getJobs(@PathVariable
                                                                                                                                   String processInstanceId)
                                                                                                                            throws org.flowable.ui.common.service.exception.BadRequestException

Throws:

org.flowable.ui.common.service.exception.BadRequestException

executeAction

@PostMapping(value="/rest/admin/process-instances/{processInstanceId}")
 @ResponseStatus(value=OK)
public void executeAction(@PathVariable
                                                                                                                             String processInstanceId,
                                                                                                                             @RequestBody
                                                                                                                             com.fasterxml.jackson.databind.JsonNode actionBody)
                                                                                                                      throws org.flowable.ui.common.service.exception.BadRequestException

Throws:

org.flowable.ui.common.service.exception.BadRequestException

changeActivityState

@PostMapping(value="/rest/admin/process-instances/{processInstanceId}/change-state")
 @ResponseStatus(value=OK)
public void changeActivityState(@PathVariable
                                                                                                                                                String processInstanceId,
                                                                                                                                                @RequestBody
                                                                                                                                                com.fasterxml.jackson.databind.JsonNode changeStateBody)
                                                                                                                                         throws org.flowable.ui.common.service.exception.BadRequestException

Throws:

org.flowable.ui.common.service.exception.BadRequestException

migrateProcessInstance

@PostMapping(value="/rest/admin/process-instances/{processInstanceId}/migrate")
 @ResponseStatus(value=OK)
public void migrateProcessInstance(@PathVariable
                                                                                                                                              String processInstanceId,
                                                                                                                                              @RequestBody
                                                                                                                                              String migrationDocument)
                                                                                                                                       throws org.flowable.ui.common.service.exception.BadRequestException

Throws:

org.flowable.ui.common.service.exception.BadRequestException

getDecisionExecutions

@GetMapping(value="/rest/admin/process-instances/{processInstanceId}/decision-executions")
public com.fasterxml.jackson.databind.JsonNode getDecisionExecutions(@PathVariable
                                                                                                                                                                String processInstanceId)
                                                                                                                                                         throws org.flowable.ui.common.service.exception.BadRequestException

Throws:

org.flowable.ui.common.service.exception.BadRequestException