Package org.qubership.atp.orchestrator.clients.api

Interface ProcessControllerApi

All Known Subinterfaces:

OrchestratorFeignClient

@Generated(value="org.openapitools.codegen.languages.SpringCodegen",
           date="2025-06-11T14:57:02.150935592Z[Etc/UTC]")
@Validated
public interface ProcessControllerApi

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<List<UUID>>	executeOrder(String authorization, @Valid ExecutionOrderDto executionOrderDto)	POST /api/v1/processorchestrator/flow/order : Create new process via Dealer or Exists Engine
org.springframework.http.ResponseEntity<UUID>	executeProcessViaDealer(@Valid FlowExecutionRequestDto flowExecutionRequestDto)	POST /api/v1/processorchestrator/flow : Create new process via Dealer or Exists Engine
org.springframework.http.ResponseEntity<UUID>	executeProcessViaDynamicBpmnGeneration(@Valid FlowExecutionRequestDto flowExecutionRequestDto)	POST /api/v1/processorchestrator/flow/bpmn : Create new process via Dealer or Exists Engine
org.springframework.http.ResponseEntity<UUID>	getRunnerProcessIdByExecutionRequestId(UUID executionRequestId)	GET /api/v1/processorchestrator/flow/er/{executionRequestId}/process/id : Get runner process id by execution request
org.springframework.http.ResponseEntity<UUID>	rerunExecutionRequestProcess(@Valid UUID newExecuteRequestId, String authorization, @Valid RerunExecutionRequestDto rerunExecutionRequestDto)	POST /api/v1/processorchestrator/flow/er/process/rerun : Restart ER with selected TR ids activity
org.springframework.http.ResponseEntity<UUID>	rerunTestRunsProcess(UUID uuid, String authorization, @Valid List<UUID> UUID)	POST /api/v1/processorchestrator/flow/er/process/restart/{uuid} : Restart ER with selected TR ids activity
org.springframework.http.ResponseEntity<String>	restartProcess(@Valid List<UUID> UUID)	POST /api/v1/processorchestrator/flow/er/process/restart : Restart ER process
org.springframework.http.ResponseEntity<String>	restartTestRunProcess(@NotNull @Valid UUID executionRequestId, @Valid List<UUID> UUID)	POST /api/v1/processorchestrator/flow/tr/process/restart : Restart TR activity
org.springframework.http.ResponseEntity<String>	resumeProcess(@Valid List<UUID> UUID)	POST /api/v1/processorchestrator/flow/er/process/resume : Resume ER process
org.springframework.http.ResponseEntity<String>	resumeTestRunProcess(@NotNull @Valid UUID executionRequestId, @Valid List<UUID> UUID)	POST /api/v1/processorchestrator/flow/tr/process/resume : Resume TR activity
org.springframework.http.ResponseEntity<String>	stopProcess(@Valid List<UUID> UUID)	POST /api/v1/processorchestrator/flow/er/process/stop : Stop ER process
org.springframework.http.ResponseEntity<String>	stopTestRunProcess(@NotNull @Valid UUID executionRequestId, @Valid List<UUID> UUID)	POST /api/v1/processorchestrator/flow/tr/process/stop : Stop TR activity
org.springframework.http.ResponseEntity<List<UUID>>	storeExecutionOrder(String authorization, @Valid ExecutionOrderDto executionOrderDto)	POST /api/v1/processorchestrator/flow/store : Store Execution Order to Orchestrator Database
org.springframework.http.ResponseEntity<String>	terminateProcess(@Valid TerminateRequestDto terminateRequestDto)	POST /api/v1/processorchestrator/flow/er/process/terminate : Terminate ER process
org.springframework.http.ResponseEntity<String>	terminateTestRunProcess(@Valid List<UUID> UUID)	POST /api/v1/processorchestrator/flow/tr/process/terminate : Terminate TR activity

Method Details

executeOrder

@RequestMapping(method=POST,
                value="/api/v1/processorchestrator/flow/order",
                produces="application/json",
                consumes="application/json")
org.springframework.http.ResponseEntity<List<UUID>> executeOrder(@RequestHeader(value="authorization",required=false)
 String authorization,
 @Valid @RequestBody(required=false)
 @Valid ExecutionOrderDto executionOrderDto)

POST /api/v1/processorchestrator/flow/order : Create new process via Dealer or Exists Engine

Parameters:

authorization - authorization (optional)

executionOrderDto - (optional)

Returns:

OK (status code 200) or Created (status code 201) or Unauthorized (status code 401) or Forbidden (status code 403) or Not Found (status code 404)

executeProcessViaDealer

@RequestMapping(method=POST,
                value="/api/v1/processorchestrator/flow",
                produces="application/json",
                consumes="application/json")
org.springframework.http.ResponseEntity<UUID> executeProcessViaDealer(@Valid @RequestBody(required=false)
 @Valid FlowExecutionRequestDto flowExecutionRequestDto)

POST /api/v1/processorchestrator/flow : Create new process via Dealer or Exists Engine

Parameters:

flowExecutionRequestDto - (optional)

Returns:

OK (status code 200) or Created (status code 201) or Unauthorized (status code 401) or Forbidden (status code 403) or Not Found (status code 404)

executeProcessViaDynamicBpmnGeneration

@RequestMapping(method=POST,
                value="/api/v1/processorchestrator/flow/bpmn",
                produces="application/json",
                consumes="application/json")
org.springframework.http.ResponseEntity<UUID> executeProcessViaDynamicBpmnGeneration(@Valid @RequestBody(required=false)
 @Valid FlowExecutionRequestDto flowExecutionRequestDto)

POST /api/v1/processorchestrator/flow/bpmn : Create new process via Dealer or Exists Engine

Parameters:

flowExecutionRequestDto - (optional)

Returns:

OK (status code 200) or Created (status code 201) or Unauthorized (status code 401) or Forbidden (status code 403) or Not Found (status code 404)

getRunnerProcessIdByExecutionRequestId

@RequestMapping(method=GET,
                value="/api/v1/processorchestrator/flow/er/{executionRequestId}/process/id",
                produces="application/json")
org.springframework.http.ResponseEntity<UUID> getRunnerProcessIdByExecutionRequestId(@PathVariable("executionRequestId")
 UUID executionRequestId)

GET /api/v1/processorchestrator/flow/er/{executionRequestId}/process/id : Get runner process id by execution request

Parameters:

executionRequestId - executionRequestId (required)

Returns:

OK (status code 200) or Unauthorized (status code 401) or Forbidden (status code 403) or Not Found (status code 404)

rerunExecutionRequestProcess

@RequestMapping(method=POST,
                value="/api/v1/processorchestrator/flow/er/process/rerun",
                produces="application/json",
                consumes="application/json")
org.springframework.http.ResponseEntity<UUID> rerunExecutionRequestProcess(@Valid @RequestParam(value="newExecuteRequestId",required=false)
 @Valid UUID newExecuteRequestId,
 @RequestHeader(value="authorization",required=false)
 String authorization,
 @Valid @RequestBody(required=false)
 @Valid RerunExecutionRequestDto rerunExecutionRequestDto)

POST /api/v1/processorchestrator/flow/er/process/rerun : Restart ER with selected TR ids activity

Parameters:

newExecuteRequestId - newExecuteRequestId (optional)

authorization - authorization (optional)

rerunExecutionRequestDto - (optional)

Returns:

OK (status code 200) or Created (status code 201) or Unauthorized (status code 401) or Forbidden (status code 403) or Not Found (status code 404)

rerunTestRunsProcess

@RequestMapping(method=POST,
                value="/api/v1/processorchestrator/flow/er/process/restart/{uuid}",
                produces="application/json",
                consumes="application/json")
org.springframework.http.ResponseEntity<UUID> rerunTestRunsProcess(@PathVariable("uuid")
 UUID uuid,
 @RequestHeader(value="Authorization",required=false)
 String authorization,
 @Valid @RequestBody(required=false)
 @Valid List<UUID> UUID)

POST /api/v1/processorchestrator/flow/er/process/restart/{uuid} : Restart ER with selected TR ids activity

Parameters:

uuid - uuid (required)

authorization - Authorization (optional)

UUID - (optional)

Returns:

OK (status code 200) or Created (status code 201) or Unauthorized (status code 401) or Forbidden (status code 403) or Not Found (status code 404)

restartProcess

@RequestMapping(method=POST,
                value="/api/v1/processorchestrator/flow/er/process/restart",
                produces="text/plain",
                consumes="application/json")
org.springframework.http.ResponseEntity<String> restartProcess(@Valid @RequestBody(required=false)
 @Valid List<UUID> UUID)

POST /api/v1/processorchestrator/flow/er/process/restart : Restart ER process

Parameters:

UUID - (optional)

Returns:

OK (status code 200) or Created (status code 201) or Unauthorized (status code 401) or Forbidden (status code 403) or Not Found (status code 404)

restartTestRunProcess

@RequestMapping(method=POST,
                value="/api/v1/processorchestrator/flow/tr/process/restart",
                produces="text/plain",
                consumes="application/json")
org.springframework.http.ResponseEntity<String> restartTestRunProcess(@NotNull @Valid @RequestParam(value="executionRequestId",required=true)
 @NotNull @Valid UUID executionRequestId,
 @Valid @RequestBody(required=false)
 @Valid List<UUID> UUID)

POST /api/v1/processorchestrator/flow/tr/process/restart : Restart TR activity

Parameters:

executionRequestId - executionRequestId (required)

UUID - (optional)

Returns:

OK (status code 200) or Created (status code 201) or Unauthorized (status code 401) or Forbidden (status code 403) or Not Found (status code 404)

resumeProcess

@RequestMapping(method=POST,
                value="/api/v1/processorchestrator/flow/er/process/resume",
                produces="text/plain",
                consumes="application/json")
org.springframework.http.ResponseEntity<String> resumeProcess(@Valid @RequestBody(required=false)
 @Valid List<UUID> UUID)

POST /api/v1/processorchestrator/flow/er/process/resume : Resume ER process

Parameters:

UUID - (optional)

Returns:

OK (status code 200) or Created (status code 201) or Unauthorized (status code 401) or Forbidden (status code 403) or Not Found (status code 404)

resumeTestRunProcess

@RequestMapping(method=POST,
                value="/api/v1/processorchestrator/flow/tr/process/resume",
                produces="text/plain",
                consumes="application/json")
org.springframework.http.ResponseEntity<String> resumeTestRunProcess(@NotNull @Valid @RequestParam(value="executionRequestId",required=true)
 @NotNull @Valid UUID executionRequestId,
 @Valid @RequestBody(required=false)
 @Valid List<UUID> UUID)

POST /api/v1/processorchestrator/flow/tr/process/resume : Resume TR activity

Parameters:

executionRequestId - executionRequestId (required)

UUID - (optional)

Returns:

OK (status code 200) or Created (status code 201) or Unauthorized (status code 401) or Forbidden (status code 403) or Not Found (status code 404)

stopProcess

@RequestMapping(method=POST,
                value="/api/v1/processorchestrator/flow/er/process/stop",
                produces="text/plain",
                consumes="application/json")
org.springframework.http.ResponseEntity<String> stopProcess(@Valid @RequestBody(required=false)
 @Valid List<UUID> UUID)

POST /api/v1/processorchestrator/flow/er/process/stop : Stop ER process

Parameters:

UUID - (optional)

Returns:

OK (status code 200) or Created (status code 201) or Unauthorized (status code 401) or Forbidden (status code 403) or Not Found (status code 404)

stopTestRunProcess

@RequestMapping(method=POST,
                value="/api/v1/processorchestrator/flow/tr/process/stop",
                produces="text/plain",
                consumes="application/json")
org.springframework.http.ResponseEntity<String> stopTestRunProcess(@NotNull @Valid @RequestParam(value="executionRequestId",required=true)
 @NotNull @Valid UUID executionRequestId,
 @Valid @RequestBody(required=false)
 @Valid List<UUID> UUID)

POST /api/v1/processorchestrator/flow/tr/process/stop : Stop TR activity

Parameters:

executionRequestId - executionRequestId (required)

UUID - (optional)

Returns:

OK (status code 200) or Created (status code 201) or Unauthorized (status code 401) or Forbidden (status code 403) or Not Found (status code 404)

storeExecutionOrder

@RequestMapping(method=POST,
                value="/api/v1/processorchestrator/flow/store",
                produces="application/json",
                consumes="application/json")
org.springframework.http.ResponseEntity<List<UUID>> storeExecutionOrder(@RequestHeader(value="authorization",required=false)
 String authorization,
 @Valid @RequestBody(required=false)
 @Valid ExecutionOrderDto executionOrderDto)

POST /api/v1/processorchestrator/flow/store : Store Execution Order to Orchestrator Database

Parameters:

authorization - authorization (optional)

executionOrderDto - (optional)

Returns:

OK (status code 200) or Created (status code 201) or Unauthorized (status code 401) or Forbidden (status code 403) or Not Found (status code 404)

terminateProcess

@RequestMapping(method=POST,
                value="/api/v1/processorchestrator/flow/er/process/terminate",
                produces="text/plain",
                consumes="application/json")
org.springframework.http.ResponseEntity<String> terminateProcess(@Valid @RequestBody(required=false)
 @Valid TerminateRequestDto terminateRequestDto)

POST /api/v1/processorchestrator/flow/er/process/terminate : Terminate ER process

Parameters:

terminateRequestDto - (optional)

Returns:

OK (status code 200) or Created (status code 201) or Unauthorized (status code 401) or Forbidden (status code 403) or Not Found (status code 404)

terminateTestRunProcess

@RequestMapping(method=POST,
                value="/api/v1/processorchestrator/flow/tr/process/terminate",
                produces="text/plain",
                consumes="application/json")
org.springframework.http.ResponseEntity<String> terminateTestRunProcess(@Valid @RequestBody(required=false)
 @Valid List<UUID> UUID)

POST /api/v1/processorchestrator/flow/tr/process/terminate : Terminate TR activity

Parameters:

UUID - (optional)

Returns:

OK (status code 200) or Created (status code 201) or Unauthorized (status code 401) or Forbidden (status code 403) or Not Found (status code 404)