Package tr.com.havelsan.javarch.bpmn.engine.cloud.client.module.runtime.service

Interface HvlBpmnRuntimeOperationalRestService

All Known Implementing Classes:
HvlBpmnRuntimeRestController
@Validated @HvlPrivateFeignRestService @FeignClient(name="bpmnRuntimePrivateRestService", path="${hvl.bpmn.service.runtime.path:/runtime}", url="${hvl.bpmn.service.runtime.url:${hvl.bpmn.service.url}}") public interface HvlBpmnRuntimeOperationalRestService
A restful service which provides specific operational methods for bpmn engine runtime.

  • Method Details

    • startProcessInstanceById

      @PostMapping(path="/start/by-process-defitinion-id/{processDefinitionId}", consumes="application/json", produces="application/json") tr.com.havelsan.javarch.service.data.HvlResponse<HvlBpmnProcessInstanceModel> startProcessInstanceById(@NotBlank @PathVariable("processDefinitionId") @NotBlank String processDefinitionId, @RequestBody HvlBpmnStartProcessInstanceModel startProcessInstanceModel)
      Start process instance.
      Parameters:
      processDefinitionId - the process definition id
      startProcessInstanceModel - the start process instance model
      Returns:
      the hvl response

    • startProcessInstanceByKey

      @PostMapping(path="/start/by-process-defitinion-key/{processDefinitionKey}", consumes="application/json", produces="application/json") tr.com.havelsan.javarch.service.data.HvlResponse<HvlBpmnProcessInstanceModel> startProcessInstanceByKey(@NotBlank @PathVariable("processDefinitionKey") @NotBlank String processDefinitionKey, @RequestBody HvlBpmnStartProcessInstanceModel startProcessInstanceModel)
      Start process instance.
      Parameters:
      processDefinitionKey - the process definition key
      startProcessInstanceModel - the start process instance model
      Returns:
      the hvl response

    • setVariable

      @PostMapping(path="/set-variable/by-execution-id/{executionId}/by-variable-name/{variableName}", consumes="application/json", produces="application/json") tr.com.havelsan.javarch.service.data.HvlResponse<Void> setVariable(@NotBlank @PathVariable("executionId") @NotBlank String executionId, @NotBlank @PathVariable("variableName") @NotBlank String variableName, @NotNull @RequestBody @NotNull Object value)
      Sets execution variable.
      Parameters:
      executionId - the execution id
      variableName - the variable name
      value - the value
      Returns:
      the variable