org.qubership.atp.environments.openapi.controllers

Interface ProjectControllerApi

All Known Subinterfaces:

AtpEnvironmentsProjectFeignClient

@Generated(value="org.openapitools.codegen.languages.SpringCodegen",
           date="2025-08-08T09:59:23.997Z[Etc/UTC]")
 @Validated
public interface ProjectControllerApi

Method Summary

Modifier and Type	Method and Description
org.springframework.http.ResponseEntity<ProjectDto>	copy(UUID projectId, @Valid ProjectDtoDto projectDtoDto) POST /api/projects/{projectId}/copy : copy
org.springframework.http.ResponseEntity<EnvironmentResDto>	createEnvironment(UUID projectId, @Valid EnvironmentDtoDto environmentDtoDto) POST /api/projects/{projectId}/environments : createEnvironment
org.springframework.http.ResponseEntity<ProjectDto>	createProject(@Valid ProjectImplDto projectImplDto) POST /api/projects : create
org.springframework.http.ResponseEntity<EnvironmentResDto>	createTool(UUID projectId, @Valid EnvironmentDtoDto environmentDtoDto) POST /api/projects/{projectId}/tools : createTool
org.springframework.http.ResponseEntity<Void>	deleteProject(UUID projectId) DELETE /api/projects/{projectId} : delete
org.springframework.http.ResponseEntity<List<EnvironmentResDto>>	getAllEnvironments(UUID projectId, @Valid Boolean full) GET /api/projects/{projectId}/environments/all : getAllEnvironments
org.springframework.http.ResponseEntity<List<ProjectFullVer2ViewDto>>	getAllProjects(@Valid String host, @Valid Boolean full) GET /api/projects : getAll
org.springframework.http.ResponseEntity<List<ProjectNameViewDto>>	getAllShort(@Valid Boolean full) GET /api/projects/short : getAllShort
org.springframework.http.ResponseEntity<List<SystemEnvironmentsViewDto>>	getAllShortSystemsOnProject(UUID projectId) GET /api/projects/{projectId}/environments/systems/short : Endpoint for getting list of systems on project by projectId
org.springframework.http.ResponseEntity<List<ProjectNameViewDto>>	getAllShortWithUserAccess(@Valid Boolean full) GET /api/projects/shortWithAccess : getAllShortWithAccess
org.springframework.http.ResponseEntity<List<ConnectionFullVer2ViewDto>>	getConnections(UUID projectId, @Valid Boolean full) GET /api/projects/{projectId}/environments/connections : getConnections
org.springframework.http.ResponseEntity<List<String>>	getConnectionsName(UUID projectId) GET /api/projects/{projectId}/environments/connections/name : getConnectionsName
org.springframework.http.ResponseEntity<List<EnvironmentResDto>>	getEnvironments(UUID projectId, @Valid Boolean full) GET /api/projects/{projectId}/environments : getEnvironments
org.springframework.http.ResponseEntity<List<EnvironmentNameViewDto>>	getEnvironmentsShort(UUID projectId) GET /api/projects/{projectId}/environments/short : getEnvironmentsShort
org.springframework.http.ResponseEntity<ProjectFullVer1ViewDto>	getProject(UUID projectId, @Valid Boolean full) GET /api/projects/{projectId} : getProject
org.springframework.http.ResponseEntity<List<SystemFullVer2ViewDto>>	getProjectSystems(UUID projectId, @Valid String category, @Valid Boolean full) GET /api/projects/{projectId}/environments/systems : getSystems
org.springframework.http.ResponseEntity<ProjectFullVer1ViewDto>	getProjectWithSpecifiedEnvironments(UUID projectId, List<UUID> environmentIds, @Valid Boolean full) GET /api/projects/{projectId}/{environmentIds} : getProjectWithSpecifiedEnvironments
org.springframework.http.ResponseEntity<List<String>>	getSystemsName(UUID projectId) GET /api/projects/{projectId}/environments/systems/name : getSystemsName
org.springframework.http.ResponseEntity<List<EnvironmentResDto>>	getTemporaryEnvironments(UUID projectId, @Valid Boolean full) GET /api/projects/{projectId}/temporary/environments : getTemporaryEnvironments
org.springframework.http.ResponseEntity<List<EnvironmentResDto>>	getTools(UUID projectId, @Valid Boolean full) GET /api/projects/{projectId}/tools : getTools
org.springframework.http.ResponseEntity<List<EnvironmentNameViewDto>>	getToolsShort(UUID projectId) GET /api/projects/{projectId}/tools/short : getToolsShort
org.springframework.http.ResponseEntity<Void>	updateProject(@Valid ProjectDtoDto projectDtoDto) PUT /api/projects : update
org.springframework.http.ResponseEntity<List<Object>>	updateSystemStatuses(UUID projectId, @Valid List<StatusDtoDto> statusDtoDto) PUT /api/projects/{projectId}/systems/status : updateSystemStatuses

Method Detail

copy

@RequestMapping(method=POST,
                value="/api/projects/{projectId}/copy",
                produces="application/json",
                consumes="application/json")
org.springframework.http.ResponseEntity<ProjectDto> copy(@PathVariable(value="projectId")
                                                                                                                                                                                                                                        UUID projectId,
                                                                                                                                                                                                                                        @Valid @RequestBody(required=false)
                                                                                                                                                                                                                                        @Valid ProjectDtoDto projectDtoDto)

POST /api/projects/{projectId}/copy : copy

Parameters:

projectId - projectId (required)

projectDtoDto - (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/projects/{projectId}/environments",
                produces="application/json",
                consumes="application/json")
org.springframework.http.ResponseEntity<EnvironmentResDto> createEnvironment(@PathVariable(value="projectId")
                                                                                                                                                                                                                                                                    UUID projectId,
                                                                                                                                                                                                                                                                    @Valid @RequestBody(required=false)
                                                                                                                                                                                                                                                                    @Valid EnvironmentDtoDto environmentDtoDto)

POST /api/projects/{projectId}/environments : createEnvironment

Parameters:

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

createProject

@RequestMapping(method=POST,
                value="/api/projects",
                produces="application/json",
                consumes="application/json")
org.springframework.http.ResponseEntity<ProjectDto> createProject(@Valid @RequestBody(required=false)
                                                                                                                                                                                                                                @Valid ProjectImplDto projectImplDto)

POST /api/projects : create

Parameters:

projectImplDto - (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/projects/{projectId}/tools",
                produces="application/json",
                consumes="application/json")
org.springframework.http.ResponseEntity<EnvironmentResDto> createTool(@PathVariable(value="projectId")
                                                                                                                                                                                                                                                      UUID projectId,
                                                                                                                                                                                                                                                      @Valid @RequestBody(required=false)
                                                                                                                                                                                                                                                      @Valid EnvironmentDtoDto environmentDtoDto)

POST /api/projects/{projectId}/tools : createTool

Parameters:

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

deleteProject

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

DELETE /api/projects/{projectId} : delete

Parameters:

projectId - projectId (required)

Returns:

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

getAllEnvironments

@RequestMapping(method=GET,
                value="/api/projects/{projectId}/environments/all",
                produces="application/json")
org.springframework.http.ResponseEntity<List<EnvironmentResDto>> getAllEnvironments(@PathVariable(value="projectId")
                                                                                                                                                                                                                                 UUID projectId,
                                                                                                                                                                                                                                 @Valid @RequestParam(value="full",required=false)
                                                                                                                                                                                                                                 @Valid Boolean full)

GET /api/projects/{projectId}/environments/all : getAllEnvironments

Parameters:

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

getAllProjects

@RequestMapping(method=GET,
                value="/api/projects",
                produces="application/json")
org.springframework.http.ResponseEntity<List<ProjectFullVer2ViewDto>> getAllProjects(@Valid @RequestParam(value="host",required=false)
                                                                                                                                                                                                     @Valid String host,
                                                                                                                                                                                                     @Valid @RequestParam(value="full",required=false)
                                                                                                                                                                                                     @Valid Boolean full)

GET /api/projects : getAll

Parameters:

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

getAllShort

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

GET /api/projects/short : getAllShort

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)

getAllShortSystemsOnProject

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

GET /api/projects/{projectId}/environments/systems/short : Endpoint for getting list of systems on project by projectId

Parameters:

projectId - Project id for getting system (required)

Returns:

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

getAllShortWithUserAccess

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

GET /api/projects/shortWithAccess : getAllShortWithAccess

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)

getConnections

@RequestMapping(method=GET,
                value="/api/projects/{projectId}/environments/connections",
                produces="application/json")
org.springframework.http.ResponseEntity<List<ConnectionFullVer2ViewDto>> getConnections(@PathVariable(value="projectId")
                                                                                                                                                                                                                                             UUID projectId,
                                                                                                                                                                                                                                             @Valid @RequestParam(value="full",required=false)
                                                                                                                                                                                                                                             @Valid Boolean full)

GET /api/projects/{projectId}/environments/connections : getConnections

Parameters:

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

getConnectionsName

@RequestMapping(method=GET,
                value="/api/projects/{projectId}/environments/connections/name",
                produces="application/json")
org.springframework.http.ResponseEntity<List<String>> getConnectionsName(@PathVariable(value="projectId")
                                                                                                                                                                                                                                   UUID projectId)

GET /api/projects/{projectId}/environments/connections/name : getConnectionsName

Parameters:

projectId - projectId (required)

Returns:

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

getEnvironments

@RequestMapping(method=GET,
                value="/api/projects/{projectId}/environments",
                produces="application/json")
org.springframework.http.ResponseEntity<List<EnvironmentResDto>> getEnvironments(@PathVariable(value="projectId")
                                                                                                                                                                                                                          UUID projectId,
                                                                                                                                                                                                                          @Valid @RequestParam(value="full",required=false)
                                                                                                                                                                                                                          @Valid Boolean full)

GET /api/projects/{projectId}/environments : getEnvironments

Parameters:

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

getEnvironmentsShort

@RequestMapping(method=GET,
                value="/api/projects/{projectId}/environments/short",
                produces="application/json")
org.springframework.http.ResponseEntity<List<EnvironmentNameViewDto>> getEnvironmentsShort(@PathVariable(value="projectId")
                                                                                                                                                                                                                                          UUID projectId)

GET /api/projects/{projectId}/environments/short : getEnvironmentsShort

Parameters:

projectId - projectId (required)

Returns:

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

getProject

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

GET /api/projects/{projectId} : getProject

Parameters:

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

getProjectSystems

@RequestMapping(method=GET,
                value="/api/projects/{projectId}/environments/systems",
                produces="application/json")
org.springframework.http.ResponseEntity<List<SystemFullVer2ViewDto>> getProjectSystems(@PathVariable(value="projectId")
                                                                                                                                                                                                                                        UUID projectId,
                                                                                                                                                                                                                                        @Valid @RequestParam(value="category",required=false)
                                                                                                                                                                                                                                        @Valid String category,
                                                                                                                                                                                                                                        @Valid @RequestParam(value="full",required=false)
                                                                                                                                                                                                                                        @Valid Boolean full)

GET /api/projects/{projectId}/environments/systems : getSystems

Parameters:

projectId - projectId (required)

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

getProjectWithSpecifiedEnvironments

@RequestMapping(method=GET,
                value="/api/projects/{projectId}/{environmentIds}",
                produces="application/json")
org.springframework.http.ResponseEntity<ProjectFullVer1ViewDto> getProjectWithSpecifiedEnvironments(@PathVariable(value="projectId")
                                                                                                                                                                                                                                                 UUID projectId,
                                                                                                                                                                                                                                                 @PathVariable(value="environmentIds")
                                                                                                                                                                                                                                                 List<UUID> environmentIds,
                                                                                                                                                                                                                                                 @Valid @RequestParam(value="full",required=false)
                                                                                                                                                                                                                                                 @Valid Boolean full)

GET /api/projects/{projectId}/{environmentIds} : getProjectWithSpecifiedEnvironments

Parameters:

projectId - projectId (required)

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

getSystemsName

@RequestMapping(method=GET,
                value="/api/projects/{projectId}/environments/systems/name",
                produces="application/json")
org.springframework.http.ResponseEntity<List<String>> getSystemsName(@PathVariable(value="projectId")
                                                                                                                                                                                                                           UUID projectId)

GET /api/projects/{projectId}/environments/systems/name : getSystemsName

Parameters:

projectId - projectId (required)

Returns:

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

getTemporaryEnvironments

@RequestMapping(method=GET,
                value="/api/projects/{projectId}/temporary/environments",
                produces="application/json")
org.springframework.http.ResponseEntity<List<EnvironmentResDto>> getTemporaryEnvironments(@PathVariable(value="projectId")
                                                                                                                                                                                                                                             UUID projectId,
                                                                                                                                                                                                                                             @Valid @RequestParam(value="full",required=false)
                                                                                                                                                                                                                                             @Valid Boolean full)

GET /api/projects/{projectId}/temporary/environments : getTemporaryEnvironments

Parameters:

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

getTools

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

GET /api/projects/{projectId}/tools : getTools

Parameters:

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

getToolsShort

@RequestMapping(method=GET,
                value="/api/projects/{projectId}/tools/short",
                produces="application/json")
org.springframework.http.ResponseEntity<List<EnvironmentNameViewDto>> getToolsShort(@PathVariable(value="projectId")
                                                                                                                                                                                                                            UUID projectId)

GET /api/projects/{projectId}/tools/short : getToolsShort

Parameters:

projectId - projectId (required)

Returns:

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

updateProject

@RequestMapping(method=PUT,
                value="/api/projects",
                consumes="application/json")
org.springframework.http.ResponseEntity<Void> updateProject(@Valid @RequestBody(required=false)
                                                                                                                                                                            @Valid ProjectDtoDto projectDtoDto)

PUT /api/projects : update

Parameters:

projectDtoDto - (optional)

Returns:

Created (status code 201) or No Content (status code 204) or Unauthorized (status code 401) or Forbidden (status code 403) or Not Found (status code 404)

updateSystemStatuses

@RequestMapping(method=PUT,
                value="/api/projects/{projectId}/systems/status",
                produces="application/json",
                consumes="application/json")
org.springframework.http.ResponseEntity<List<Object>> updateSystemStatuses(@PathVariable(value="projectId")
                                                                                                                                                                                                                                                                   UUID projectId,
                                                                                                                                                                                                                                                                   @Valid @RequestBody(required=false)
                                                                                                                                                                                                                                                                   @Valid List<StatusDtoDto> statusDtoDto)

PUT /api/projects/{projectId}/systems/status : updateSystemStatuses

Parameters:

projectId - projectId (required)

statusDtoDto - (optional)

Returns:

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