Package org.qubership.atp.macros.clients.api

Interface MacroControllerApi

All Known Subinterfaces:

MacrosFeignClient

@Generated(value="org.openapitools.codegen.languages.SpringCodegen",
           date="2025-07-24T11:51:16.096766586Z[Etc/UTC]",
           comments="Generator version: 7.6.0")
@Validated
public interface MacroControllerApi

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<Void>	create(@Valid MacrosDto macrosDto)	POST /api/v1/macros : Create a new macros
org.springframework.http.ResponseEntity<Void>	delete(UUID uuid)	DELETE /api/v1/macros/{uuid} : Delete specified macros
org.springframework.http.ResponseEntity<String>	evaluate(@Valid String body)	POST /api/v1/macros/evaluate : Evaluate specified content
org.springframework.http.ResponseEntity<String>	evaluateWithContext(@Valid EvaluationRequestDto evaluationRequestDto)	POST /api/v1/macros/evaluate/context : Evaluate specified content with context
org.springframework.http.ResponseEntity<List<MacrosDto>>	findAll()	GET /api/v1/macros/all : Get all available macros
org.springframework.http.ResponseEntity<List<MacrosDto>>	findAllByProject(UUID uuid)	GET /api/v1/macros/all/project/{uuid} : Get all available macros for specified project (including global)
org.springframework.http.ResponseEntity<List<MacrosDto>>	findAllByProjectId(UUID uuid)	GET /api/v1/macros/project/{uuid}/all : Get all macros for specified project
org.springframework.http.ResponseEntity<MacrosPageDto>	findByProjectId(UUID uuid, @Valid Integer page, @Valid Integer size, @Valid String sort, @Valid String direction)	GET /api/v1/macros/project/{uuid} : Get specified page of all available macros for specified project
org.springframework.http.ResponseEntity<MacrosPageDto>	findGlobal(@Valid Integer page, @Valid Integer size, @Valid String sort, @Valid String direction)	GET /api/v1/macros/global : Get all available global macros
org.springframework.http.ResponseEntity<List<MacrosDto>>	findNonTechnicalMacrosByProject(UUID uuid)	GET /api/v1/macros/all-nontechnical/project/{uuid} : Get all non technical available macros for specified project (including global)
org.springframework.http.ResponseEntity<List<ScriptEngineDto>>	getEngines()	GET /api/v1/macros/engines : Get all available script engines
org.springframework.http.ResponseEntity<MacrosDto>	update(UUID uuid, @Valid MacrosDto macrosDto)	PUT /api/v1/macros/{uuid} : Update specified macros

Method Details

create

@RequestMapping(method=POST,
                value="/api/v1/macros",
                produces="application/json",
                consumes="application/json")
org.springframework.http.ResponseEntity<Void> create(@Valid @RequestBody(required=false)
 @Valid MacrosDto macrosDto)

POST /api/v1/macros : Create a new macros

Parameters:

macrosDto - (optional)

Returns:

Successful response (status code 200) or Created (status code 201) or Bad request (status code 400) or Unauthorized (status code 401) or Forbidden (status code 403) or Not Found (status code 404)

delete

@RequestMapping(method=DELETE,
                value="/api/v1/macros/{uuid}")
org.springframework.http.ResponseEntity<Void> delete(@PathVariable("uuid")
 UUID uuid)

DELETE /api/v1/macros/{uuid} : Delete specified macros

Parameters:

uuid - uuid (required)

Returns:

Successful response (status code 200) or No Content (status code 204) or Bad request (status code 400) or Unauthorized (status code 401) or Forbidden (status code 403) or Macros not found (status code 404)

evaluate

@RequestMapping(method=POST,
                value="/api/v1/macros/evaluate",
                produces="application/json",
                consumes="application/json")
org.springframework.http.ResponseEntity<String> evaluate(@Valid @RequestBody(required=false)
 @Valid String body)

POST /api/v1/macros/evaluate : Evaluate specified content

Parameters:

body - (optional)

Returns:

Successful response (status code 200) or Created (status code 201) or Bad request (status code 400) or Unauthorized (status code 401) or Forbidden (status code 403) or Not Found (status code 404)

evaluateWithContext

@RequestMapping(method=POST,
                value="/api/v1/macros/evaluate/context",
                produces="application/json",
                consumes="application/json")
org.springframework.http.ResponseEntity<String> evaluateWithContext(@Valid @RequestBody(required=false)
 @Valid EvaluationRequestDto evaluationRequestDto)

POST /api/v1/macros/evaluate/context : Evaluate specified content with context

Parameters:

evaluationRequestDto - (optional)

Returns:

Successful response (status code 200) or Created (status code 201) or Bad request (status code 400) or Unauthorized (status code 401) or Forbidden (status code 403) or Not Found (status code 404)

findAll

@RequestMapping(method=GET,
                value="/api/v1/macros/all",
                produces="application/json")
org.springframework.http.ResponseEntity<List<MacrosDto>> findAll()

GET /api/v1/macros/all : Get all available macros

Returns:

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

findAllByProject

@RequestMapping(method=GET,
                value="/api/v1/macros/all/project/{uuid}",
                produces="application/json")
org.springframework.http.ResponseEntity<List<MacrosDto>> findAllByProject(@PathVariable("uuid")
 UUID uuid)

GET /api/v1/macros/all/project/{uuid} : Get all available macros for specified project (including global)

Parameters:

uuid - uuid (required)

Returns:

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

findAllByProjectId

@RequestMapping(method=GET,
                value="/api/v1/macros/project/{uuid}/all",
                produces="application/json")
org.springframework.http.ResponseEntity<List<MacrosDto>> findAllByProjectId(@PathVariable("uuid")
 UUID uuid)

GET /api/v1/macros/project/{uuid}/all : Get all macros for specified project

Parameters:

uuid - uuid (required)

Returns:

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

findByProjectId

@RequestMapping(method=GET,
                value="/api/v1/macros/project/{uuid}",
                produces="application/json")
org.springframework.http.ResponseEntity<MacrosPageDto> findByProjectId(@PathVariable("uuid")
 UUID uuid,
 @Valid @RequestParam(value="page",required=false)
 @Valid Integer page,
 @Valid @RequestParam(value="size",required=false)
 @Valid Integer size,
 @Valid @RequestParam(value="sort",required=false)
 @Valid String sort,
 @Valid @RequestParam(value="direction",required=false)
 @Valid String direction)

GET /api/v1/macros/project/{uuid} : Get specified page of all available macros for specified project

Parameters:

uuid - uuid (required)

page - page (optional)

size - size (optional)

sort - sort (optional)

direction - direction (optional)

Returns:

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

findGlobal

@RequestMapping(method=GET,
                value="/api/v1/macros/global",
                produces="application/json")
org.springframework.http.ResponseEntity<MacrosPageDto> findGlobal(@Valid @RequestParam(value="page",required=false)
 @Valid Integer page,
 @Valid @RequestParam(value="size",required=false)
 @Valid Integer size,
 @Valid @RequestParam(value="sort",required=false)
 @Valid String sort,
 @Valid @RequestParam(value="direction",required=false)
 @Valid String direction)

GET /api/v1/macros/global : Get all available global macros

Parameters:

page - page (optional)

size - size (optional)

sort - sort (optional)

direction - direction (optional)

Returns:

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

findNonTechnicalMacrosByProject

@RequestMapping(method=GET,
                value="/api/v1/macros/all-nontechnical/project/{uuid}",
                produces="application/json")
org.springframework.http.ResponseEntity<List<MacrosDto>> findNonTechnicalMacrosByProject(@PathVariable("uuid")
 UUID uuid)

GET /api/v1/macros/all-nontechnical/project/{uuid} : Get all non technical available macros for specified project (including global)

Parameters:

uuid - uuid (required)

Returns:

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

getEngines

@RequestMapping(method=GET,
                value="/api/v1/macros/engines",
                produces="application/json")
org.springframework.http.ResponseEntity<List<ScriptEngineDto>> getEngines()

GET /api/v1/macros/engines : Get all available script engines

Returns:

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

update

@RequestMapping(method=PUT,
                value="/api/v1/macros/{uuid}",
                produces="application/json",
                consumes="application/json")
org.springframework.http.ResponseEntity<MacrosDto> update(@PathVariable("uuid")
 UUID uuid,
 @Valid @RequestBody(required=false)
 @Valid MacrosDto macrosDto)

PUT /api/v1/macros/{uuid} : Update specified macros

Parameters:

uuid - uuid (required)

macrosDto - (optional)

Returns:

Successful response (status code 200) or Created (status code 201) or Bad request (status code 400) or Unauthorized (status code 401) or Forbidden (status code 403) or Not Found (status code 404)