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

Interface SystemControllerApi

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

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<SystemFullVer1ViewDtoGenerated>	copy(UUID systemId, @Valid CreateSystemDtoDtoGenerated createSystemDtoDtoGenerated)	POST /api/systems/{systemId}/copy : copy
org.springframework.http.ResponseEntity<SystemFullVer1ViewDtoGenerated>	createSystem(@Valid CreateSystemDtoDtoGenerated createSystemDtoDtoGenerated)	POST /api/systems : create
org.springframework.http.ResponseEntity<Void>	deleteLinkedSystems(UUID systemId, UUID environmentId)	DELETE /api/systems/link/{systemId}/{environmentId} : deleteLinkedSystems
org.springframework.http.ResponseEntity<Void>	deleteSystem(UUID systemId, @NotNull @Valid UUID environmentId)	DELETE /api/systems/{systemId} : delete
org.springframework.http.ResponseEntity<List<SystemFullVer1ViewDtoGenerated>>	getAll(@Valid Boolean full)	GET /api/systems : getAll
org.springframework.http.ResponseEntity<List<SystemEnvironmentsViewDtoGenerated>>	getAllSystems(@Valid Boolean full)	GET /api/systems/short : Endpoint for getting list of systems on all projects
org.springframework.http.ResponseEntity<Object>	getCachedVersion(UUID systemId)	GET /api/public/v1/systems/{systemId}/version : getCachedVersion
org.springframework.http.ResponseEntity<String>	getHtmlVersion(UUID systemId)	GET /api/systems/{systemId}/htmlVersion : getHtmlVersion
org.springframework.http.ResponseEntity<List<ShortExternalServiceDtoGenerated>>	getKubernetesServiceNames(UUID systemId)	GET /api/systems/shortKubeServices/{systemId} : getKubernetesServiceNames
org.springframework.http.ResponseEntity<List<SystemFullVer1ViewDtoGenerated>>	getLinkedCloudServices(UUID systemId)	GET /api/systems/link/{systemId} : getLinkedCloudServices
org.springframework.http.ResponseEntity<List<ShortExternalServiceDtoGenerated>>	getOpenshiftServiceNames(UUID systemId)	GET /api/systems/shortOpenshiftServices/{systemId} : getOpenshiftServiceNames
org.springframework.http.ResponseEntity<String>	getPublicHtmlVersion(UUID systemId)	GET /api/public/v1/systems/{systemId}/htmlVersion : getPublicHtmlVersion
org.springframework.http.ResponseEntity<SystemFullVer1ViewDtoGenerated>	getShortSystem(UUID systemId, @Valid Boolean full)	GET /api/systems/short/{systemId} : getShortSystem
org.springframework.http.ResponseEntity<SystemFullVer1ViewDtoGenerated>	getSystem(UUID systemId, @Valid Boolean full)	GET /api/systems/{systemId} : getSystem
org.springframework.http.ResponseEntity<SystemFullVer1ViewDtoGenerated>	getSystemByName(UUID environmentId, String name, @Valid Boolean full)	GET /api/systems/byName/{environmentId}/{name} : getSystemByName
org.springframework.http.ResponseEntity<List<ConnectionFullVer1ViewDtoGenerated>>	getSystemConnections(UUID systemId, @Valid Boolean full)	GET /api/systems/{systemId}/connections : getSystems
org.springframework.http.ResponseEntity<SystemFullVer2ViewDtoGenerated>	getSystemV2(UUID systemId, @Valid Boolean full)	GET /api/v2/systems/{systemId} : getSystemV2
org.springframework.http.ResponseEntity<List<ConnectionFullVer1ViewDtoGenerated>>	openshiftUpdateRoutes(@Valid CreateSystemDtoDtoGenerated createSystemDtoDtoGenerated)	PUT /api/systems/openshift : openshiftUpdateRoutes
org.springframework.http.ResponseEntity<SystemFullVer2ViewDtoGenerated>	share(UUID systemId, @NotNull @Valid UUID environmentId, @Valid Long modified)	PUT /api/systems/{systemId}/share : share
org.springframework.http.ResponseEntity<List<SystemFullVer1ViewDtoGenerated>>	synchronizeServicesFromKubernetes(UUID systemId, UUID environmentId, @Valid SynchronizeCloudServicesRequestDtoGenerated synchronizeCloudServicesRequestDtoGenerated)	POST /api/systems/kubeServices/{environmentId}/{systemId} : synchronizeServicesFromKubernetes
org.springframework.http.ResponseEntity<List<SystemFullVer1ViewDtoGenerated>>	synchronizeServicesFromOpenShift(UUID systemId, UUID environmentId, @Valid SynchronizeCloudServicesRequestDtoGenerated synchronizeCloudServicesRequestDtoGenerated)	POST /api/systems/openshiftServices/{environmentId}/{systemId} : synchronizeServicesFromOpenShift
org.springframework.http.ResponseEntity<SystemFullVer2ViewDtoGenerated>	unShare(UUID systemId, @NotNull @Valid UUID environmentId, @Valid Long modified)	PUT /api/systems/{systemId}/unshare : unShare
org.springframework.http.ResponseEntity<SystemFullVer1ViewDtoGenerated>	updateParametersGettingVersion(UUID systemId, @Valid ParametersGettingVersionDtoGenerated parametersGettingVersionDtoGenerated)	PUT /api/systems/{systemId}/parametersGettingVersion : updateParametersGettingVersion
org.springframework.http.ResponseEntity<List<SystemFullVer2ViewDtoGenerated>>	updateServicesFromKubernetes(UUID systemId)	GET /api/systems/kubeServices/{systemId} : updateServicesFromKubernetes
org.springframework.http.ResponseEntity<List<SystemFullVer2ViewDtoGenerated>>	updateServicesFromOpenshift(UUID systemId)	GET /api/systems/openshiftServices/{systemId} : updateServicesFromOpenshift
org.springframework.http.ResponseEntity<SystemFullVer1ViewDtoGenerated>	updateSystem(@Valid SystemDtoDtoGenerated systemDtoDtoGenerated)	PUT /api/systems : update
org.springframework.http.ResponseEntity<SystemFullVer1ViewDtoGenerated>	updateVersion(UUID systemId)	GET /api/systems/{systemId}/version : updateVersion

Method Details

copy

@RequestMapping(method=POST,
                value="/api/systems/{systemId}/copy",
                produces="application/json",
                consumes="application/json")
org.springframework.http.ResponseEntity<SystemFullVer1ViewDtoGenerated> copy(@PathVariable("systemId")
 UUID systemId,
 @Valid @RequestBody(required=false)
 @Valid CreateSystemDtoDtoGenerated createSystemDtoDtoGenerated)

POST /api/systems/{systemId}/copy : copy

Parameters:

systemId - systemId (required)

createSystemDtoDtoGenerated - (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/systems",
                produces="application/json",
                consumes="application/json")
org.springframework.http.ResponseEntity<SystemFullVer1ViewDtoGenerated> createSystem(@Valid @RequestBody(required=false)
 @Valid CreateSystemDtoDtoGenerated createSystemDtoDtoGenerated)

POST /api/systems : create

Parameters:

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

deleteLinkedSystems

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

DELETE /api/systems/link/{systemId}/{environmentId} : deleteLinkedSystems

Parameters:

systemId - systemId (required)

environmentId - systemId (required)

Returns:

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

deleteSystem

@RequestMapping(method=DELETE,
                value="/api/systems/{systemId}")
org.springframework.http.ResponseEntity<Void> deleteSystem(@PathVariable("systemId")
 UUID systemId,
 @NotNull @Valid @RequestParam(value="environmentId",required=true)
 @NotNull @Valid UUID environmentId)

DELETE /api/systems/{systemId} : delete

Parameters:

systemId - systemId (required)

environmentId - environmentId (required)

Returns:

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

getAll

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

GET /api/systems : 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)

getAllSystems

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

GET /api/systems/short : Endpoint for getting list of systems on all projects

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)

getCachedVersion

@RequestMapping(method=GET,
                value="/api/public/v1/systems/{systemId}/version",
                produces="application/json")
org.springframework.http.ResponseEntity<Object> getCachedVersion(@PathVariable("systemId")
 UUID systemId)

GET /api/public/v1/systems/{systemId}/version : getCachedVersion

Parameters:

systemId - systemId (required)

Returns:

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

getHtmlVersion

@RequestMapping(method=GET,
                value="/api/systems/{systemId}/htmlVersion",
                produces="text/plain")
org.springframework.http.ResponseEntity<String> getHtmlVersion(@PathVariable("systemId")
 UUID systemId)

GET /api/systems/{systemId}/htmlVersion : getHtmlVersion

Parameters:

systemId - systemId (required)

Returns:

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

getKubernetesServiceNames

@RequestMapping(method=GET,
                value="/api/systems/shortKubeServices/{systemId}",
                produces="application/json")
org.springframework.http.ResponseEntity<List<ShortExternalServiceDtoGenerated>> getKubernetesServiceNames(@PathVariable("systemId")
 UUID systemId)

GET /api/systems/shortKubeServices/{systemId} : getKubernetesServiceNames

Parameters:

systemId - systemId (required)

Returns:

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

getLinkedCloudServices

@RequestMapping(method=GET,
                value="/api/systems/link/{systemId}",
                produces="application/json")
org.springframework.http.ResponseEntity<List<SystemFullVer1ViewDtoGenerated>> getLinkedCloudServices(@PathVariable("systemId")
 UUID systemId)

GET /api/systems/link/{systemId} : getLinkedCloudServices

Parameters:

systemId - systemId (required)

Returns:

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

getOpenshiftServiceNames

@RequestMapping(method=GET,
                value="/api/systems/shortOpenshiftServices/{systemId}",
                produces="application/json")
org.springframework.http.ResponseEntity<List<ShortExternalServiceDtoGenerated>> getOpenshiftServiceNames(@PathVariable("systemId")
 UUID systemId)

GET /api/systems/shortOpenshiftServices/{systemId} : getOpenshiftServiceNames

Parameters:

systemId - systemId (required)

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/systems/{systemId}/htmlVersion",
                produces="text/plain")
org.springframework.http.ResponseEntity<String> getPublicHtmlVersion(@PathVariable("systemId")
 UUID systemId)

GET /api/public/v1/systems/{systemId}/htmlVersion : getPublicHtmlVersion

Parameters:

systemId - systemId (required)

Returns:

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

getShortSystem

@RequestMapping(method=GET,
                value="/api/systems/short/{systemId}",
                produces="application/json")
org.springframework.http.ResponseEntity<SystemFullVer1ViewDtoGenerated> getShortSystem(@PathVariable("systemId")
 UUID systemId,
 @Valid @RequestParam(value="full",required=false)
 @Valid Boolean full)

GET /api/systems/short/{systemId} : getShortSystem

Parameters:

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

getSystem

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

GET /api/systems/{systemId} : getSystem

Parameters:

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

getSystemByName

@RequestMapping(method=GET,
                value="/api/systems/byName/{environmentId}/{name}",
                produces="application/json")
org.springframework.http.ResponseEntity<SystemFullVer1ViewDtoGenerated> getSystemByName(@PathVariable("environmentId")
 UUID environmentId,
 @PathVariable("name")
 String name,
 @Valid @RequestParam(value="full",required=false)
 @Valid Boolean full)

GET /api/systems/byName/{environmentId}/{name} : getSystemByName

Parameters:

environmentId - environmentId (required)

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

getSystemConnections

@RequestMapping(method=GET,
                value="/api/systems/{systemId}/connections",
                produces="application/json")
org.springframework.http.ResponseEntity<List<ConnectionFullVer1ViewDtoGenerated>> getSystemConnections(@PathVariable("systemId")
 UUID systemId,
 @Valid @RequestParam(value="full",required=false)
 @Valid Boolean full)

GET /api/systems/{systemId}/connections : getSystems

Parameters:

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

GET /api/v2/systems/{systemId} : getSystemV2

Parameters:

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

openshiftUpdateRoutes

@RequestMapping(method=PUT,
                value="/api/systems/openshift",
                produces="application/json",
                consumes="application/json")
org.springframework.http.ResponseEntity<List<ConnectionFullVer1ViewDtoGenerated>> openshiftUpdateRoutes(@Valid @RequestBody(required=false)
 @Valid CreateSystemDtoDtoGenerated createSystemDtoDtoGenerated)

PUT /api/systems/openshift : openshiftUpdateRoutes

Parameters:

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

share

@RequestMapping(method=PUT,
                value="/api/systems/{systemId}/share",
                produces="application/json")
org.springframework.http.ResponseEntity<SystemFullVer2ViewDtoGenerated> share(@PathVariable("systemId")
 UUID systemId,
 @NotNull @Valid @RequestParam(value="environmentId",required=true)
 @NotNull @Valid UUID environmentId,
 @Valid @RequestParam(value="modified",required=false)
 @Valid Long modified)

PUT /api/systems/{systemId}/share : share

Parameters:

systemId - systemId (required)

environmentId - environmentId (required)

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

synchronizeServicesFromKubernetes

@RequestMapping(method=POST,
                value="/api/systems/kubeServices/{environmentId}/{systemId}",
                produces="application/json",
                consumes="application/json")
org.springframework.http.ResponseEntity<List<SystemFullVer1ViewDtoGenerated>> synchronizeServicesFromKubernetes(@PathVariable("systemId")
 UUID systemId,
 @PathVariable("environmentId")
 UUID environmentId,
 @Valid @RequestBody(required=false)
 @Valid SynchronizeCloudServicesRequestDtoGenerated synchronizeCloudServicesRequestDtoGenerated)

POST /api/systems/kubeServices/{environmentId}/{systemId} : synchronizeServicesFromKubernetes

Parameters:

systemId - systemId (required)

environmentId - environmentId (required)

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

synchronizeServicesFromOpenShift

@RequestMapping(method=POST,
                value="/api/systems/openshiftServices/{environmentId}/{systemId}",
                produces="application/json",
                consumes="application/json")
org.springframework.http.ResponseEntity<List<SystemFullVer1ViewDtoGenerated>> synchronizeServicesFromOpenShift(@PathVariable("systemId")
 UUID systemId,
 @PathVariable("environmentId")
 UUID environmentId,
 @Valid @RequestBody(required=false)
 @Valid SynchronizeCloudServicesRequestDtoGenerated synchronizeCloudServicesRequestDtoGenerated)

POST /api/systems/openshiftServices/{environmentId}/{systemId} : synchronizeServicesFromOpenShift

Parameters:

systemId - systemId (required)

environmentId - environmentId (required)

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

unShare

@RequestMapping(method=PUT,
                value="/api/systems/{systemId}/unshare",
                produces="application/json")
org.springframework.http.ResponseEntity<SystemFullVer2ViewDtoGenerated> unShare(@PathVariable("systemId")
 UUID systemId,
 @NotNull @Valid @RequestParam(value="environmentId",required=true)
 @NotNull @Valid UUID environmentId,
 @Valid @RequestParam(value="modified",required=false)
 @Valid Long modified)

PUT /api/systems/{systemId}/unshare : unShare

Parameters:

systemId - systemId (required)

environmentId - environmentId (required)

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

updateParametersGettingVersion

@RequestMapping(method=PUT,
                value="/api/systems/{systemId}/parametersGettingVersion",
                produces="application/json",
                consumes="application/json")
org.springframework.http.ResponseEntity<SystemFullVer1ViewDtoGenerated> updateParametersGettingVersion(@PathVariable("systemId")
 UUID systemId,
 @Valid @RequestBody(required=false)
 @Valid ParametersGettingVersionDtoGenerated parametersGettingVersionDtoGenerated)

PUT /api/systems/{systemId}/parametersGettingVersion : updateParametersGettingVersion

Parameters:

systemId - systemId (required)

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

updateServicesFromKubernetes

@RequestMapping(method=GET,
                value="/api/systems/kubeServices/{systemId}",
                produces="application/json")
org.springframework.http.ResponseEntity<List<SystemFullVer2ViewDtoGenerated>> updateServicesFromKubernetes(@PathVariable("systemId")
 UUID systemId)

GET /api/systems/kubeServices/{systemId} : updateServicesFromKubernetes

Parameters:

systemId - systemId (required)

Returns:

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

updateServicesFromOpenshift

@RequestMapping(method=GET,
                value="/api/systems/openshiftServices/{systemId}",
                produces="application/json")
org.springframework.http.ResponseEntity<List<SystemFullVer2ViewDtoGenerated>> updateServicesFromOpenshift(@PathVariable("systemId")
 UUID systemId)

GET /api/systems/openshiftServices/{systemId} : updateServicesFromOpenshift

Parameters:

systemId - systemId (required)

Returns:

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

updateSystem

@RequestMapping(method=PUT,
                value="/api/systems",
                produces="application/json",
                consumes="application/json")
org.springframework.http.ResponseEntity<SystemFullVer1ViewDtoGenerated> updateSystem(@Valid @RequestBody(required=false)
 @Valid SystemDtoDtoGenerated systemDtoDtoGenerated)

PUT /api/systems : update

Parameters:

systemDtoDtoGenerated - (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/systems/{systemId}/version",
                produces="application/json")
org.springframework.http.ResponseEntity<SystemFullVer1ViewDtoGenerated> updateVersion(@PathVariable("systemId")
 UUID systemId)

GET /api/systems/{systemId}/version : updateVersion

Parameters:

systemId - systemId (required)

Returns:

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