Package org.qubership.atp.environments.service.rest.server.generated

Interface ToolControllerApi

@Generated(value="org.openapitools.codegen.languages.SpringCodegen",
           date="2025-10-02T09:52:46.776740422Z[Etc/UTC]")
@Validated
public interface ToolControllerApi

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<EnvironmentDtoGenerated>	copyTool(UUID toolGroupId, @Valid EnvironmentDtoDtoGenerated environmentDtoDtoGenerated)	POST /api/tools/{toolGroupId}/copy : copy
org.springframework.http.ResponseEntity<EnvironmentDtoGenerated>	createTool(@Valid EnvironmentDtoDtoGenerated environmentDtoDtoGenerated)	POST /api/tools : create
org.springframework.http.ResponseEntity<Void>	deleteTool(UUID toolGroupId)	DELETE /api/tools/{toolGroupId} : delete
org.springframework.http.ResponseEntity<List<EnvironmentDtoGenerated>>	getAll(@Valid Boolean full)	GET /api/tools : getAll
org.springframework.http.ResponseEntity<EnvironmentDtoGenerated>	getEnvironment(UUID toolGroupId, @Valid Boolean full)	GET /api/tools/{toolGroupId} : getEnvironment
org.springframework.http.ResponseEntity<List<SystemFullVer2ViewDtoGenerated>>	getSystemV2(UUID toolGroupId, @Valid String systemType, @Valid Boolean full)	GET /api/v2/tools/{toolGroupId}/systems : getSystemV2
org.springframework.http.ResponseEntity<List<SystemFullVer1ViewDtoGenerated>>	getToolSystems(UUID toolGroupId, @Valid String systemType, @Valid Boolean full)	GET /api/tools/{toolGroupId}/systems : getSystems
org.springframework.http.ResponseEntity<Void>	updateTool(@Valid EnvironmentDtoDtoGenerated environmentDtoDtoGenerated)	PUT /api/tools : update
org.springframework.http.ResponseEntity<List<SystemDtoGenerated>>	updateVersion(UUID toolGroupId)	GET /api/tools/{toolGroupId}/version : updateVersion
org.springframework.http.ResponseEntity<ValidateTaToolsResponseDtoGenerated>	validateTaTools(@Valid ValidateTaToolsRequestDtoGenerated validateTaToolsRequestDtoGenerated)	POST /api/tools/validate : validateTaTools

Method Details

copyTool

@RequestMapping(method=POST,
                value="/api/tools/{toolGroupId}/copy",
                produces="application/json",
                consumes="application/json")
org.springframework.http.ResponseEntity<EnvironmentDtoGenerated> copyTool(@PathVariable("toolGroupId")
 UUID toolGroupId,
 @Valid @RequestBody(required=false)
 @Valid EnvironmentDtoDtoGenerated environmentDtoDtoGenerated)

POST /api/tools/{toolGroupId}/copy : copy

Parameters:

toolGroupId - toolGroupId (required)

environmentDtoDtoGenerated - (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)

createTool

@RequestMapping(method=POST,
                value="/api/tools",
                produces="application/json",
                consumes="application/json")
org.springframework.http.ResponseEntity<EnvironmentDtoGenerated> createTool(@Valid @RequestBody(required=false)
 @Valid EnvironmentDtoDtoGenerated environmentDtoDtoGenerated)

POST /api/tools : create

Parameters:

environmentDtoDtoGenerated - (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)

deleteTool

@RequestMapping(method=DELETE,
                value="/api/tools/{toolGroupId}")
org.springframework.http.ResponseEntity<Void> deleteTool(@PathVariable("toolGroupId")
 UUID toolGroupId)

DELETE /api/tools/{toolGroupId} : delete

Parameters:

toolGroupId - toolGroupId (required)

Returns:

No Content (status code 204) or Unauthorized (status code 401) or Forbidden (status code 403)

getAll

@RequestMapping(method=GET,
                value="/api/tools",
                produces="application/json")
org.springframework.http.ResponseEntity<List<EnvironmentDtoGenerated>> getAll(@Valid @RequestParam(value="full",required=false)
 @Valid Boolean full)

GET /api/tools : getAll

Parameters:

full - full (optional)

Returns:

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

getEnvironment

@RequestMapping(method=GET,
                value="/api/tools/{toolGroupId}",
                produces="application/json")
org.springframework.http.ResponseEntity<EnvironmentDtoGenerated> getEnvironment(@PathVariable("toolGroupId")
 UUID toolGroupId,
 @Valid @RequestParam(value="full",required=false)
 @Valid Boolean full)

GET /api/tools/{toolGroupId} : getEnvironment

Parameters:

toolGroupId - toolGroupId (required)

full - full (optional)

Returns:

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

getSystemV2

@RequestMapping(method=GET,
                value="/api/v2/tools/{toolGroupId}/systems",
                produces="application/json")
org.springframework.http.ResponseEntity<List<SystemFullVer2ViewDtoGenerated>> getSystemV2(@PathVariable("toolGroupId")
 UUID toolGroupId,
 @Valid @RequestParam(value="system_type",required=false)
 @Valid String systemType,
 @Valid @RequestParam(value="full",required=false)
 @Valid Boolean full)

GET /api/v2/tools/{toolGroupId}/systems : getSystemV2

Parameters:

toolGroupId - toolGroupId (required)

systemType - system_type (optional)

full - full (optional)

Returns:

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

getToolSystems

@RequestMapping(method=GET,
                value="/api/tools/{toolGroupId}/systems",
                produces="application/json")
org.springframework.http.ResponseEntity<List<SystemFullVer1ViewDtoGenerated>> getToolSystems(@PathVariable("toolGroupId")
 UUID toolGroupId,
 @Valid @RequestParam(value="system_type",required=false)
 @Valid String systemType,
 @Valid @RequestParam(value="full",required=false)
 @Valid Boolean full)

GET /api/tools/{toolGroupId}/systems : getSystems

Parameters:

toolGroupId - toolGroupId (required)

systemType - system_type (optional)

full - full (optional)

Returns:

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

updateTool

@RequestMapping(method=PUT,
                value="/api/tools",
                consumes="application/json")
org.springframework.http.ResponseEntity<Void> updateTool(@Valid @RequestBody(required=false)
 @Valid EnvironmentDtoDtoGenerated environmentDtoDtoGenerated)

PUT /api/tools : update

Parameters:

environmentDtoDtoGenerated - (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)

updateVersion

@RequestMapping(method=GET,
                value="/api/tools/{toolGroupId}/version",
                produces="application/json")
org.springframework.http.ResponseEntity<List<SystemDtoGenerated>> updateVersion(@PathVariable("toolGroupId")
 UUID toolGroupId)

GET /api/tools/{toolGroupId}/version : updateVersion

Parameters:

toolGroupId - toolGroupId (required)

Returns:

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

validateTaTools

@RequestMapping(method=POST,
                value="/api/tools/validate",
                produces="application/json",
                consumes="application/json")
org.springframework.http.ResponseEntity<ValidateTaToolsResponseDtoGenerated> validateTaTools(@Valid @RequestBody(required=false)
 @Valid ValidateTaToolsRequestDtoGenerated validateTaToolsRequestDtoGenerated)

POST /api/tools/validate : validateTaTools

Parameters:

validateTaToolsRequestDtoGenerated - (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)