Package org.qubership.atp.ram.clients.api

Interface EnvironmentControllerApi

All Known Subinterfaces:

EnvironmentFeignClient

@Generated(value="org.openapitools.codegen.languages.SpringCodegen",
           date="2025-10-03T13:16:58.681771617Z[Etc/UTC]")
@Validated
public interface EnvironmentControllerApi

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<EnvironmentDto>	copy(UUID environmentId, @Valid EnvironmentDtoDto environmentDtoDto)	POST /api/environments/{environmentId}/copy : copy
org.springframework.http.ResponseEntity<EnvironmentDto>	createEnvironment(@Valid EnvironmentDtoDto environmentDtoDto)	POST /api/environments : createEnvironment
org.springframework.http.ResponseEntity<SystemDto>	createSystem(UUID environmentId, @Valid CreateSystemDtoDto createSystemDtoDto)	POST /api/environments/{environmentId} : createSystem
org.springframework.http.ResponseEntity<Void>	deleteEnvironment(UUID environmentId)	DELETE /api/environments/{environmentId} : delete
org.springframework.http.ResponseEntity<List<SystemVersionResponseDto>>	detailedUpdateVersion(UUID environmentId)	GET /api/v2/environments/{environmentId}/version : detailedUpdateVersion
org.springframework.http.ResponseEntity<List<EnvironmentDto>>	findBySearchRequest(@Valid BaseSearchRequestDto baseSearchRequestDto, @Valid Boolean full)	POST /api/environments/search : findBySearchRequest
org.springframework.http.ResponseEntity<List<EnvironmentFullVer1ViewDto>>	getAll(@Valid Boolean full)	GET /api/environments : getAll
org.springframework.http.ResponseEntity<EnvironmentFullVer1ViewDto>	getEnvironment(UUID environmentId, @Valid Boolean full)	GET /api/environments/{environmentId} : getEnvironment
org.springframework.http.ResponseEntity<List<ConnectionDto>>	getEnvironmentConnections(UUID environmentId)	GET /api/environments/{environmentId}/connections : getEnvironmentConnections
org.springframework.http.ResponseEntity<String>	getEnvironmentNameById(UUID environmentId)	GET /api/environments/{environmentId}/name : getName
org.springframework.http.ResponseEntity<List<EnvironmentFullVer1ViewDto>>	getEnvironmentsByRequest(@Valid Boolean full, @Valid Long page, @Valid Long size, @Valid EnvironmentsWithFilterRequestDto environmentsWithFilterRequestDto)	POST /api/environments/filter : getEnvironmentsByRequest
org.springframework.http.ResponseEntity<List<SystemFullVer1ViewDto>>	getEnvironmentSystems(UUID environmentId, @Valid String systemType, @Valid Boolean full)	GET /api/environments/{environmentId}/systems : getSystems
org.springframework.http.ResponseEntity<EnvironmentFullVer1ViewDto>	getEnvironmentTsg3(UUID environmentId, @Valid Boolean full)	GET /api/environments/{environmentId}/systems/update-versions : Returns all systems with updated versions under environment
org.springframework.http.ResponseEntity<String>	getPublicHtmlVersion(List<UUID> environmentIds)	GET /api/public/v1/environments/{environmentIds}/systems/htmlVersions : getPublicHtmlVersion
org.springframework.http.ResponseEntity<List<SystemNameViewDto>>	getSystemsShort(UUID environmentId)	GET /api/environments/{environmentId}/systems/short : getSystemsShort
org.springframework.http.ResponseEntity<List<SystemFullVer2ViewDto>>	getSystemV2(UUID environmentId, @Valid String systemType, @Valid Boolean full)	GET /api/v2/environments/{environmentId}/systems : getSystemV2
org.springframework.http.ResponseEntity<EnvironmentFullVer1ViewDto>	temporary(UUID environmentId, @Valid Boolean full, @Valid List<SystemTemporaryDtoDto> systemTemporaryDtoDto)	POST /api/environments/{environmentId}/temporary : temporary
org.springframework.http.ResponseEntity<Void>	updateEnvironment(@Valid EnvironmentDtoDto environmentDtoDto)	PUT /api/environments : update
org.springframework.http.ResponseEntity<List<SystemDto>>	updateVersion(UUID environmentId)	GET /api/environments/{environmentId}/version : updateVersion

Method Details

copy

@RequestMapping(method=POST,
                value="/api/environments/{environmentId}/copy",
                produces="application/json",
                consumes="application/json")
org.springframework.http.ResponseEntity<EnvironmentDto> copy(@PathVariable("environmentId")
 UUID environmentId,
 @Valid @RequestBody(required=false)
 @Valid EnvironmentDtoDto environmentDtoDto)

POST /api/environments/{environmentId}/copy : copy

Parameters:

environmentId - environmentId (required)

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

createEnvironment

@RequestMapping(method=POST,
                value="/api/environments",
                produces="application/json",
                consumes="application/json")
org.springframework.http.ResponseEntity<EnvironmentDto> createEnvironment(@Valid @RequestBody(required=false)
 @Valid EnvironmentDtoDto environmentDtoDto)

POST /api/environments : createEnvironment

Parameters:

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

createSystem

@RequestMapping(method=POST,
                value="/api/environments/{environmentId}",
                produces="application/json",
                consumes="application/json")
org.springframework.http.ResponseEntity<SystemDto> createSystem(@PathVariable("environmentId")
 UUID environmentId,
 @Valid @RequestBody(required=false)
 @Valid CreateSystemDtoDto createSystemDtoDto)

POST /api/environments/{environmentId} : createSystem

Parameters:

environmentId - environmentId (required)

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

deleteEnvironment

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

DELETE /api/environments/{environmentId} : delete

Parameters:

environmentId - environmentId (required)

Returns:

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

detailedUpdateVersion

@RequestMapping(method=GET,
                value="/api/v2/environments/{environmentId}/version",
                produces="application/json")
org.springframework.http.ResponseEntity<List<SystemVersionResponseDto>> detailedUpdateVersion(@PathVariable("environmentId")
 UUID environmentId)

GET /api/v2/environments/{environmentId}/version : detailedUpdateVersion

Parameters:

environmentId - environmentId (required)

Returns:

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

findBySearchRequest

@RequestMapping(method=POST,
                value="/api/environments/search",
                produces="application/json",
                consumes="application/json")
org.springframework.http.ResponseEntity<List<EnvironmentDto>> findBySearchRequest(@Valid @RequestBody
 @Valid BaseSearchRequestDto baseSearchRequestDto,
 @Valid @RequestParam(value="full",required=false)
 @Valid Boolean full)

POST /api/environments/search : findBySearchRequest

Parameters:

baseSearchRequestDto - searchRequest (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)

getAll

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

GET /api/environments : 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/environments/{environmentId}",
                produces="application/json")
org.springframework.http.ResponseEntity<EnvironmentFullVer1ViewDto> getEnvironment(@PathVariable("environmentId")
 UUID environmentId,
 @Valid @RequestParam(value="full",required=false)
 @Valid Boolean full)

GET /api/environments/{environmentId} : getEnvironment

Parameters:

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

getEnvironmentConnections

@RequestMapping(method=GET,
                value="/api/environments/{environmentId}/connections",
                produces="application/json")
org.springframework.http.ResponseEntity<List<ConnectionDto>> getEnvironmentConnections(@PathVariable("environmentId")
 UUID environmentId)

GET /api/environments/{environmentId}/connections : getEnvironmentConnections

Parameters:

environmentId - environmentId (required)

Returns:

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

getEnvironmentNameById

@RequestMapping(method=GET,
                value="/api/environments/{environmentId}/name",
                produces="text/plain")
org.springframework.http.ResponseEntity<String> getEnvironmentNameById(@PathVariable("environmentId")
 UUID environmentId)

GET /api/environments/{environmentId}/name : getName

Parameters:

environmentId - environmentId (required)

Returns:

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

getEnvironmentSystems

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

GET /api/environments/{environmentId}/systems : getSystems

Parameters:

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

getEnvironmentTsg3

@RequestMapping(method=GET,
                value="/api/environments/{environmentId}/systems/update-versions",
                produces="application/json")
org.springframework.http.ResponseEntity<EnvironmentFullVer1ViewDto> getEnvironmentTsg3(@PathVariable("environmentId")
 UUID environmentId,
 @Valid @RequestParam(value="full",required=false)
 @Valid Boolean full)

GET /api/environments/{environmentId}/systems/update-versions : Returns all systems with updated versions under environment

Parameters:

environmentId - Id of the environment. Cannot be empty. (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)

getEnvironmentsByRequest

@RequestMapping(method=POST,
                value="/api/environments/filter",
                produces="application/json",
                consumes="application/json")
org.springframework.http.ResponseEntity<List<EnvironmentFullVer1ViewDto>> getEnvironmentsByRequest(@Valid @RequestParam(value="full",required=false)
 @Valid Boolean full,
 @Valid @RequestParam(value="page",required=false)
 @Valid Long page,
 @Valid @RequestParam(value="size",required=false)
 @Valid Long size,
 @Valid @RequestBody(required=false)
 @Valid EnvironmentsWithFilterRequestDto environmentsWithFilterRequestDto)

POST /api/environments/filter : getEnvironmentsByRequest

Parameters:

full - full (optional)

page - full (optional)

size - full (optional)

environmentsWithFilterRequestDto - (optional)

Returns:

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

getPublicHtmlVersion

@RequestMapping(method=GET,
                value="/api/public/v1/environments/{environmentIds}/systems/htmlVersions",
                produces="text/plain")
org.springframework.http.ResponseEntity<String> getPublicHtmlVersion(@PathVariable("environmentIds")
 List<UUID> environmentIds)

GET /api/public/v1/environments/{environmentIds}/systems/htmlVersions : getPublicHtmlVersion

Parameters:

environmentIds - environmentIds (required)

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/environments/{environmentId}/systems",
                produces="application/json")
org.springframework.http.ResponseEntity<List<SystemFullVer2ViewDto>> getSystemV2(@PathVariable("environmentId")
 UUID environmentId,
 @Valid @RequestParam(value="system_type",required=false)
 @Valid String systemType,
 @Valid @RequestParam(value="full",required=false)
 @Valid Boolean full)

GET /api/v2/environments/{environmentId}/systems : getSystemV2

Parameters:

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

getSystemsShort

@RequestMapping(method=GET,
                value="/api/environments/{environmentId}/systems/short",
                produces="application/json")
org.springframework.http.ResponseEntity<List<SystemNameViewDto>> getSystemsShort(@PathVariable("environmentId")
 UUID environmentId)

GET /api/environments/{environmentId}/systems/short : getSystemsShort

Parameters:

environmentId - environmentId (required)

Returns:

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

temporary

@RequestMapping(method=POST,
                value="/api/environments/{environmentId}/temporary",
                produces="application/json",
                consumes="application/json")
org.springframework.http.ResponseEntity<EnvironmentFullVer1ViewDto> temporary(@PathVariable("environmentId")
 UUID environmentId,
 @Valid @RequestParam(value="full",required=false)
 @Valid Boolean full,
 @Valid @RequestBody(required=false)
 @Valid List<SystemTemporaryDtoDto> systemTemporaryDtoDto)

POST /api/environments/{environmentId}/temporary : temporary

Parameters:

environmentId - environmentId (required)

full - full (optional)

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

updateEnvironment

@RequestMapping(method=PUT,
                value="/api/environments",
                consumes="application/json")
org.springframework.http.ResponseEntity<Void> updateEnvironment(@Valid @RequestBody(required=false)
 @Valid EnvironmentDtoDto environmentDtoDto)

PUT /api/environments : update

Parameters:

environmentDtoDto - (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/environments/{environmentId}/version",
                produces="application/json")
org.springframework.http.ResponseEntity<List<SystemDto>> updateVersion(@PathVariable("environmentId")
 UUID environmentId)

GET /api/environments/{environmentId}/version : updateVersion

Parameters:

environmentId - environmentId (required)

Returns:

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