Package com.flowable.action.rest.service.api.repository

Class ActionDefinitionResource

java.lang.Object

com.flowable.action.rest.service.api.action.BaseActionResource

com.flowable.action.rest.service.api.repository.ActionDefinitionResource

@RestController
public class ActionDefinitionResource
extends BaseActionResource

Author:

Tijs Rademakers, Joram Barrez

Field Summary

Fields

Modifier and Type	Field	Description
protected ActionDefinitionMapper	actionDefinitionMapper
protected ActionEngineConfiguration	actionEngineConfiguration
protected ActionRepositoryService	actionRepositoryService
protected ActionRuntimeService	actionRuntimeService
protected ActionTemplateService	actionTemplateService
protected com.flowable.core.service.form.FlowableFormDecoratorInvoker	formDecoratorInvoker

Fields inherited from class com.flowable.action.rest.service.api.action.BaseActionResource

actionEngineConfigurationApi, additionalAdminUsers, defaultListResponseSize, formRepositoryService, platformIdentityService, platformSecurityInterceptor

Constructor Summary

Constructors

Constructor	Description
ActionDefinitionResource(org.springframework.beans.factory.ObjectProvider<ActionTemplateService> actionTemplateServiceProvider, ActionRepositoryService actionRepositoryService)

Method Summary

Modifier and Type	Method	Description
protected ActionDefinitionResponse	createAndInitializeActionDefinitionResponse(ActionDefinition actionDefinition, ActionDefinitionModel actionDefinitionModel)
ActionInstanceExecutionResponse	executeActionDefinition(java.lang.String actionDefinitionId, java.lang.String scopeDefinitionId, java.lang.String scopeId, java.lang.String scopeType, java.lang.String formDefinitionId, java.lang.String formFieldId, java.util.Map<java.lang.String,java.lang.Object> payload)
ActionInstanceExecutionResponse	executeActionDefinitionByKey(java.lang.String actionDefinitionKey, java.lang.String scopeDefinitionId, java.lang.String scopeId, java.lang.String scopeType, java.lang.String formDefinitionId, java.lang.String formFieldId, java.util.Map<java.lang.String,java.lang.Object> payload)
ActionDefinitionResponse	getActionDefinitionById(java.lang.String actionDefinitionId, java.lang.String scopeId, java.lang.String scopeType, java.lang.String formDefinitionId, java.lang.String formFieldId)
ActionDefinitionResponse	getActionDefinitionByKey(java.lang.String actionDefinitionKey, java.lang.String scopeId, java.lang.String scopeType, java.lang.String formDefinitionId, java.lang.String formFieldId)
org.flowable.form.api.FormModel	getActionDefinitionFormById(java.lang.String actionDefinitionId, java.lang.String scopeId, java.lang.String scopeType, java.lang.String formDefinitionId, java.lang.String formFieldId)
org.flowable.form.api.FormModel	getActionDefinitionFormByKey(java.lang.String actionDefinitionKey, java.lang.String scopeId, java.lang.String scopeType, java.lang.String formDefinitionId, java.lang.String formFieldId)
protected ActionDefinition	getActionDefinitionFromRequest(java.lang.String actionDefinitionId)
protected org.flowable.form.api.FormModel	getFormModel(ActionDefinition actionDefinition, ActionDefinitionModel actionDefinitionModel)
protected ActionInstanceExecutionResponse	performExecuteActionDefinition(java.lang.String actionDefinitionId, java.lang.String actionDefinitionKey, java.lang.String scopeDefinitionId, java.lang.String scopeId, java.lang.String scopeType, java.lang.String formDefinitionId, java.lang.String formFieldId, java.util.Map<java.lang.String,java.lang.Object> payload)

Methods inherited from class com.flowable.action.rest.service.api.action.BaseActionResource

currentUserHasAccess, currentUserHasAccess, currentUserHasAccess, currentUserHasAccess, currentUserHasAccess, currentUserHasAccess, currentUserHasAccessToActionInForm, currentUserHasAdminRights, currentUserIsSuperAdmin, extractPermissionGroups, getScopedObject

Methods inherited from class java.lang.Object

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

Field Details

actionRuntimeService

@Autowired protected ActionRuntimeService actionRuntimeService

actionDefinitionMapper

@Autowired protected ActionDefinitionMapper actionDefinitionMapper

formDecoratorInvoker

@Autowired protected com.flowable.core.service.form.FlowableFormDecoratorInvoker formDecoratorInvoker

actionEngineConfiguration

@Autowired protected ActionEngineConfiguration actionEngineConfiguration

actionRepositoryService

protected final ActionRepositoryService actionRepositoryService

actionTemplateService

protected final ActionTemplateService actionTemplateService

Constructor Details

ActionDefinitionResource

public ActionDefinitionResource(org.springframework.beans.factory.ObjectProvider<ActionTemplateService> actionTemplateServiceProvider, ActionRepositoryService actionRepositoryService)

Method Details

getActionDefinitionById

@GetMapping(value="/action-repository/action-definitions/{actionDefinitionId}", produces="application/json") public ActionDefinitionResponse getActionDefinitionById(@PathVariable("actionDefinitionId") java.lang.String actionDefinitionId, @RequestParam(required=false) java.lang.String scopeId, @RequestParam(required=false) java.lang.String scopeType, @RequestParam(required=false,name="formId") java.lang.String formDefinitionId, @RequestParam(required=false) java.lang.String formFieldId)

getActionDefinitionByKey

@GetMapping(value="/action-repository/action-definitions/key/{actionDefinitionKey}", produces="application/json") public ActionDefinitionResponse getActionDefinitionByKey(@PathVariable("actionDefinitionKey") java.lang.String actionDefinitionKey, @RequestParam(required=false) java.lang.String scopeId, @RequestParam(required=false) java.lang.String scopeType, @RequestParam(required=false,name="formId") java.lang.String formDefinitionId, @RequestParam(required=false) java.lang.String formFieldId)

getActionDefinitionFormById

@GetMapping(value="/action-repository/action-definitions/{actionDefinitionId}/form-model", produces="application/json") public org.flowable.form.api.FormModel getActionDefinitionFormById(@PathVariable("actionDefinitionId") java.lang.String actionDefinitionId, @RequestParam(required=false) java.lang.String scopeId, @RequestParam(required=false) java.lang.String scopeType, @RequestParam(required=false,name="formId") java.lang.String formDefinitionId, @RequestParam(required=false) java.lang.String formFieldId)

getActionDefinitionFormByKey

@GetMapping(value="/action-repository/action-definitions/key/{actionDefinitionKey}/form-model", produces="application/json") public org.flowable.form.api.FormModel getActionDefinitionFormByKey(@PathVariable("actionDefinitionKey") java.lang.String actionDefinitionKey, @RequestParam(required=false) java.lang.String scopeId, @RequestParam(required=false) java.lang.String scopeType, @RequestParam(required=false,name="formId") java.lang.String formDefinitionId, @RequestParam(required=false) java.lang.String formFieldId)

executeActionDefinition

@PostMapping(value="/action-repository/action-definitions/{actionDefinitionId}/execute", produces="application/json") public ActionInstanceExecutionResponse executeActionDefinition(@PathVariable("actionDefinitionId") java.lang.String actionDefinitionId, @RequestParam(required=false) java.lang.String scopeDefinitionId, @RequestParam(required=false) java.lang.String scopeId, @RequestParam(required=false) java.lang.String scopeType, @RequestParam(required=false,name="formId") java.lang.String formDefinitionId, @RequestParam(required=false) java.lang.String formFieldId, @RequestBody java.util.Map<java.lang.String,java.lang.Object> payload)

executeActionDefinitionByKey

@PostMapping(value="/action-repository/action-definitions/key/{actionDefinitionKey}/execute", produces="application/json") public ActionInstanceExecutionResponse executeActionDefinitionByKey(@PathVariable("actionDefinitionKey") java.lang.String actionDefinitionKey, @RequestParam(required=false) java.lang.String scopeDefinitionId, @RequestParam(required=false) java.lang.String scopeId, @RequestParam(required=false) java.lang.String scopeType, @RequestParam(required=false,name="formId") java.lang.String formDefinitionId, @RequestParam(required=false) java.lang.String formFieldId, @RequestBody java.util.Map<java.lang.String,java.lang.Object> payload)

createAndInitializeActionDefinitionResponse

protected ActionDefinitionResponse createAndInitializeActionDefinitionResponse(ActionDefinition actionDefinition, ActionDefinitionModel actionDefinitionModel)

performExecuteActionDefinition

protected ActionInstanceExecutionResponse performExecuteActionDefinition(java.lang.String actionDefinitionId, java.lang.String actionDefinitionKey, java.lang.String scopeDefinitionId, java.lang.String scopeId, java.lang.String scopeType, java.lang.String formDefinitionId, java.lang.String formFieldId, java.util.Map<java.lang.String,java.lang.Object> payload)

getFormModel

protected org.flowable.form.api.FormModel getFormModel(ActionDefinition actionDefinition, ActionDefinitionModel actionDefinitionModel)

getActionDefinitionFromRequest

protected ActionDefinition getActionDefinitionFromRequest(java.lang.String actionDefinitionId)