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

Interface HvlBpmnRuntimeRestService

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

  • Method Details

    • isExecutionExists

      @GetMapping(path="/is-execution-exists/by-business-key/{businessKey}", produces="application/json") tr.com.havelsan.javarch.service.data.HvlResponse<Boolean> isExecutionExists(@NotBlank @PathVariable("businessKey") @NotBlank String businessKey)
      Check the execution is existed.
      Parameters:
      businessKey - the business key
      Returns:
      the hvl response

    • queryList

      @PostMapping(path="/list", consumes="application/json", produces="application/json") tr.com.havelsan.javarch.service.data.HvlResponse<List<HvlBpmnProcessInstanceModel>> queryList(@NotNull @RequestBody @NotNull HvlBpmnProcessInstanceQueryModel processInstanceQueryModel)
      Returns a list of process instance matching the query criteria.
      Parameters:
      processInstanceQueryModel - the process instance query model
      Returns:
      the hvl response

    • queryPage

      @PostMapping(path="/page", consumes="application/json", produces="application/json") tr.com.havelsan.javarch.service.data.HvlResponse<tr.com.havelsan.javarch.data.commons.pageable.HvlPage<HvlBpmnProcessInstanceModel>> queryPage(@NotNull @RequestBody @NotNull HvlBpmnProcessInstanceQueryModel processDefinitionQueryModel)
      Returns a page of process instance matching the query criteria.
      Parameters:
      processDefinitionQueryModel - the process definition query model
      Returns:
      the hvl response

    • getVariables

      @GetMapping(path="/variables/by-execution-id/{executionId}", produces="application/json") tr.com.havelsan.javarch.service.data.HvlResponse<Map<String,Object>> getVariables(@NotBlank @PathVariable("executionId") @NotBlank String executionId)
      Gets execution variables.
      Parameters:
      executionId - the execution id
      Returns:
      the variables

    • getVariable

      @PostMapping(path="/variables/by-execution-id/{executionId}/by-variable-name/{variableName}", produces="application/json") tr.com.havelsan.javarch.service.data.HvlResponse<Object> getVariable(@NotBlank @PathVariable("executionId") @NotBlank String executionId, @NotBlank @PathVariable("variableName") @NotBlank String variableName)
      Gets execution variable.
      Parameters:
      executionId - the execution id
      variableName - the variable name
      Returns:
      the variable