org.flowable.ui.admin.rest.client

Class ProcessDefinitionClientResource

java.lang.Object

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

org.flowable.ui.admin.rest.client.ProcessDefinitionClientResource

@RestController
public class ProcessDefinitionClientResource
extends AbstractClientResource

REST controller for managing the current user's account.

Field Summary

Fields

Modifier and Type	Field and Description
protected ProcessDefinitionService	clientService
protected JobService	jobService
protected com.fasterxml.jackson.databind.ObjectMapper	objectMapper
protected ProcessInstanceService	processInstanceService

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

configRepository

Constructor Summary

Constructors

Constructor and Description
ProcessDefinitionClientResource()

Method Summary

Modifier and Type	Method and Description
com.fasterxml.jackson.databind.JsonNode	getJobs(String definitionId)
com.fasterxml.jackson.databind.JsonNode	getProcessDefinition(String definitionId) GET /rest/authenticate -> check if the user is authenticated, and return its login.
com.fasterxml.jackson.databind.JsonNode	getProcessInstances(String definitionId)
void	migrateInstancesOfProcessDefinition(String definitionId, String migrationDocument)
com.fasterxml.jackson.databind.JsonNode	updateProcessDefinitionCategory(String definitionId, com.fasterxml.jackson.databind.node.ObjectNode updateBody)

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 ProcessDefinitionService clientService

processInstanceService

@Autowired
protected ProcessInstanceService processInstanceService

jobService

@Autowired
protected JobService jobService

objectMapper

@Autowired
protected com.fasterxml.jackson.databind.ObjectMapper objectMapper

Constructor Detail

ProcessDefinitionClientResource

public ProcessDefinitionClientResource()

Method Detail

getProcessDefinition

@GetMapping(value="/rest/admin/process-definitions/{definitionId}",
            produces="application/json")
public com.fasterxml.jackson.databind.JsonNode getProcessDefinition(@PathVariable
                                                                                                                                                                                 String definitionId)
                                                                                                                                                                          throws org.flowable.ui.common.service.exception.BadRequestException

GET /rest/authenticate -> check if the user is authenticated, and return its login.

Throws:

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

updateProcessDefinitionCategory

@PutMapping(value="/rest/admin/process-definitions/{definitionId}",
            produces="application/json")
public com.fasterxml.jackson.databind.JsonNode updateProcessDefinitionCategory(@PathVariable
                                                                                                                                                                                            String definitionId,
                                                                                                                                                                                            @RequestBody
                                                                                                                                                                                            com.fasterxml.jackson.databind.node.ObjectNode updateBody)
                                                                                                                                                                                     throws org.flowable.ui.common.service.exception.BadRequestException

Throws:

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

getProcessInstances

@GetMapping(value="/rest/admin/process-definitions/{definitionId}/process-instances",
            produces="application/json")
public com.fasterxml.jackson.databind.JsonNode getProcessInstances(@PathVariable
                                                                                                                                                                                                  String definitionId)
                                                                                                                                                                                           throws org.flowable.ui.common.service.exception.BadRequestException

Throws:

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

getJobs

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

Throws:

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

migrateInstancesOfProcessDefinition

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

Throws:

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