Package tr.com.havelsan.javarch.bpmn.admin.cloud.client.module.process.service

Interface HvlBpmnProcessDocOperationalRestService

All Known Implementing Classes:

HvlBpmnProcessDocRestController

@Validated
@HvlPublicFeignRestService
@FeignClient(name="bpmnProcessDocAttachmentOperationalRestService",
             path="${hvl.bpmn.service.process.path:/process/doc}",
             url="${hvl.bpmn.service.process.url:${hvl.bpmn.service.url}}")
public interface HvlBpmnProcessDocOperationalRestService

A restful service which provides specific operational methods for bpmn process documentation attachment.

Method Summary

Modifier and Type	Method	Description
tr.com.havelsan.javarch.service.data.HvlResponse<String>	generateDocumentation(@jakarta.validation.constraints.NotNull long processId)	Generates documentation from bpmn model.
tr.com.havelsan.javarch.service.data.HvlResponse<String>	generateDocumentationForce(@jakarta.validation.constraints.NotNull long processId)	Generates documentation from bpmn model.

Method Details

generateDocumentation

@GetMapping(path="/generate-documentation/{processId}",
            produces="application/json")
tr.com.havelsan.javarch.service.data.HvlResponse<String> generateDocumentation(@NotNull @PathVariable("processId")
 @jakarta.validation.constraints.NotNull long processId)

Generates documentation from bpmn model.

Parameters:

processId - the processId

Returns:

documentation in json format which also represents bpmn flow

generateDocumentationForce

@GetMapping(path="/generate-documentation/force/{processId}",
            produces="application/json")
tr.com.havelsan.javarch.service.data.HvlResponse<String> generateDocumentationForce(@NotNull @PathVariable("processId")
 @jakarta.validation.constraints.NotNull long processId)

Generates documentation from bpmn model. Forces to regeneration instead of cached one

Parameters:

processId - the processId

Returns:

documentation in json format which also represents bpmn flow