Package org.qubership.atp.environments.clients.api.healthcheck

Interface StatusControllerApi

All Known Subinterfaces:

HealthcheckFeignClient

@Generated(value="org.openapitools.codegen.languages.SpringCodegen",
           date="2025-06-05T07:24:46.361723454Z[Etc/UTC]")
@Validated
public interface StatusControllerApi

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<EnvironmentStatusDto>	checkEnvironment(String projectId, String environmentId, @Valid Boolean status, @Valid Boolean _configuration, @Valid Boolean onlyMandatory)	GET /rest/status/{projectId}/{environmentId} : checkEnvironment
org.springframework.http.ResponseEntity<EnvironmentStatusDto>	checkEnvironmentByNames(String projectName, String environmentName, @Valid Boolean status, @Valid Boolean _configuration, @Valid Boolean onlyMandatory)	GET /rest/status/byNames/{projectName}/{environmentName} : checkEnvironmentByNames
org.springframework.http.ResponseEntity<EnvironmentStatusDto>	checkEnvironmentByNamesAndSendNotifications(String projectName, String environmentName, String subscribers, @Valid String reportSubject, @Valid Boolean fail, @Valid Boolean warn, @Valid Boolean pass, @Valid Boolean status, @Valid Boolean _configuration, @Valid Boolean onlyMandatory)	GET /rest/status/byNames/sentTo/{subscribers}/{projectName}/{environmentName} : checkEnvironmentByNamesAndSendNotifications
org.springframework.http.ResponseEntity<EnvironmentStatusDto>	checkEnvironmentWithSpecifiedSystems(String projectId, String environmentId, String systemIds, @Valid Boolean status, @Valid Boolean _configuration, @Valid Boolean onlyMandatory)	GET /rest/status/{projectId}/{environmentId}/{systemIds} : checkEnvironmentWithSpecifiedSystems
org.springframework.http.ResponseEntity<EnvironmentStatusDto>	checkEnvironmentWithSpecifiedSystemsByNames(String projectName, String environmentName, String systemNames, @Valid Boolean status, @Valid Boolean _configuration, @Valid Boolean onlyMandatory)	GET /rest/status/byNames/{projectName}/{environmentName}/{systemNames} : checkEnvironmentWithSpecifiedSystemsByNames
org.springframework.http.ResponseEntity<EnvironmentStatusDto>	checkEnvironmentWithSpecifiedSystemsByNamesAndSendNotifications(String projectName, String environmentName, String systemNames, String subscribers, @Valid String reportSubject, @Valid Boolean fail, @Valid Boolean warn, @Valid Boolean pass, @Valid Boolean status, @Valid Boolean _configuration, @Valid Boolean onlyMandatory)	GET /rest/status/byNames/sentTo/{subscribers}/{projectName}/{environmentName}/{systemNames} : checkEnvironmentWithSpecifiedSystemsByNamesAndSendNotifications
org.springframework.http.ResponseEntity<List<EnvironmentStatusDto>>	checkProject(String projectId, @Valid Boolean status, @Valid Boolean _configuration)	GET /rest/status/timezones/{projectId} : checkProject
org.springframework.http.ResponseEntity<SystemStatusDto>	checkSystem(String projectId, String environmentId, String systemId, @Valid Boolean status, @Valid Boolean _configuration, @Valid Boolean onlyMandatory)	GET /rest/status/system/{projectId}/{environmentId}/{systemId} : checkSystem
org.springframework.http.ResponseEntity<MandatoryStatusesResponseDto>	mandatoryCheckEnvironments(UUID projectId, List<UUID> environmentIds, UUID executionRequestId, @Valid Boolean status, @Valid Boolean _configuration)	GET /rest/status/report/{projectId}/{environmentIds}/{executionRequestId} : mandatoryCheckEnvironments

Method Details

checkEnvironment

@RequestMapping(method=GET,
                value="/rest/status/{projectId}/{environmentId}",
                produces="application/json")
org.springframework.http.ResponseEntity<EnvironmentStatusDto> checkEnvironment(@PathVariable("projectId")
 String projectId,
 @PathVariable("environmentId")
 String environmentId,
 @Valid @RequestParam(value="status",required=false)
 @Valid Boolean status,
 @Valid @RequestParam(value="configuration",required=false)
 @Valid Boolean _configuration,
 @Valid @RequestParam(value="onlyMandatory",required=false)
 @Valid Boolean onlyMandatory)

GET /rest/status/{projectId}/{environmentId} : checkEnvironment

Parameters:

projectId - projectId (required)

environmentId - environmentId (required)

status - status (optional)

_configuration - configuration (optional)

onlyMandatory - status (optional)

Returns:

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

checkEnvironmentByNames

@RequestMapping(method=GET,
                value="/rest/status/byNames/{projectName}/{environmentName}",
                produces="application/json")
org.springframework.http.ResponseEntity<EnvironmentStatusDto> checkEnvironmentByNames(@PathVariable("projectName")
 String projectName,
 @PathVariable("environmentName")
 String environmentName,
 @Valid @RequestParam(value="status",required=false)
 @Valid Boolean status,
 @Valid @RequestParam(value="configuration",required=false)
 @Valid Boolean _configuration,
 @Valid @RequestParam(value="onlyMandatory",required=false)
 @Valid Boolean onlyMandatory)

GET /rest/status/byNames/{projectName}/{environmentName} : checkEnvironmentByNames

Parameters:

projectName - projectName (required)

environmentName - environmentName (required)

status - status (optional)

_configuration - configuration (optional)

onlyMandatory - status (optional)

Returns:

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

checkEnvironmentByNamesAndSendNotifications

@RequestMapping(method=GET,
                value="/rest/status/byNames/sentTo/{subscribers}/{projectName}/{environmentName}",
                produces="application/json")
org.springframework.http.ResponseEntity<EnvironmentStatusDto> checkEnvironmentByNamesAndSendNotifications(@PathVariable("projectName")
 String projectName,
 @PathVariable("environmentName")
 String environmentName,
 @PathVariable("subscribers")
 String subscribers,
 @Valid @RequestParam(value="reportSubject",required=false)
 @Valid String reportSubject,
 @Valid @RequestParam(value="fail",required=false)
 @Valid Boolean fail,
 @Valid @RequestParam(value="warn",required=false)
 @Valid Boolean warn,
 @Valid @RequestParam(value="pass",required=false)
 @Valid Boolean pass,
 @Valid @RequestParam(value="status",required=false)
 @Valid Boolean status,
 @Valid @RequestParam(value="configuration",required=false)
 @Valid Boolean _configuration,
 @Valid @RequestParam(value="onlyMandatory",required=false)
 @Valid Boolean onlyMandatory)

GET /rest/status/byNames/sentTo/{subscribers}/{projectName}/{environmentName} : checkEnvironmentByNamesAndSendNotifications

Parameters:

projectName - projectName (required)

environmentName - environmentName (required)

subscribers - subscribers (required)

reportSubject - reportSubject (optional)

fail - fail (optional)

warn - warn (optional)

pass - pass (optional)

status - status (optional)

_configuration - configuration (optional)

onlyMandatory - status (optional)

Returns:

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

checkEnvironmentWithSpecifiedSystems

@RequestMapping(method=GET,
                value="/rest/status/{projectId}/{environmentId}/{systemIds}",
                produces="application/json")
org.springframework.http.ResponseEntity<EnvironmentStatusDto> checkEnvironmentWithSpecifiedSystems(@PathVariable("projectId")
 String projectId,
 @PathVariable("environmentId")
 String environmentId,
 @PathVariable("systemIds")
 String systemIds,
 @Valid @RequestParam(value="status",required=false)
 @Valid Boolean status,
 @Valid @RequestParam(value="configuration",required=false)
 @Valid Boolean _configuration,
 @Valid @RequestParam(value="onlyMandatory",required=false)
 @Valid Boolean onlyMandatory)

GET /rest/status/{projectId}/{environmentId}/{systemIds} : checkEnvironmentWithSpecifiedSystems

Parameters:

projectId - projectId (required)

environmentId - environmentId (required)

systemIds - systemIds (required)

status - status (optional)

_configuration - configuration (optional)

onlyMandatory - status (optional)

Returns:

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

checkEnvironmentWithSpecifiedSystemsByNames

@RequestMapping(method=GET,
                value="/rest/status/byNames/{projectName}/{environmentName}/{systemNames}",
                produces="application/json")
org.springframework.http.ResponseEntity<EnvironmentStatusDto> checkEnvironmentWithSpecifiedSystemsByNames(@PathVariable("projectName")
 String projectName,
 @PathVariable("environmentName")
 String environmentName,
 @PathVariable("systemNames")
 String systemNames,
 @Valid @RequestParam(value="status",required=false)
 @Valid Boolean status,
 @Valid @RequestParam(value="configuration",required=false)
 @Valid Boolean _configuration,
 @Valid @RequestParam(value="onlyMandatory",required=false)
 @Valid Boolean onlyMandatory)

GET /rest/status/byNames/{projectName}/{environmentName}/{systemNames} : checkEnvironmentWithSpecifiedSystemsByNames

Parameters:

projectName - projectName (required)

environmentName - environmentName (required)

systemNames - systemNames (required)

status - status (optional)

_configuration - configuration (optional)

onlyMandatory - status (optional)

Returns:

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

checkEnvironmentWithSpecifiedSystemsByNamesAndSendNotifications

@RequestMapping(method=GET,
                value="/rest/status/byNames/sentTo/{subscribers}/{projectName}/{environmentName}/{systemNames}",
                produces="application/json")
org.springframework.http.ResponseEntity<EnvironmentStatusDto> checkEnvironmentWithSpecifiedSystemsByNamesAndSendNotifications(@PathVariable("projectName")
 String projectName,
 @PathVariable("environmentName")
 String environmentName,
 @PathVariable("systemNames")
 String systemNames,
 @PathVariable("subscribers")
 String subscribers,
 @Valid @RequestParam(value="reportSubject",required=false)
 @Valid String reportSubject,
 @Valid @RequestParam(value="fail",required=false)
 @Valid Boolean fail,
 @Valid @RequestParam(value="warn",required=false)
 @Valid Boolean warn,
 @Valid @RequestParam(value="pass",required=false)
 @Valid Boolean pass,
 @Valid @RequestParam(value="status",required=false)
 @Valid Boolean status,
 @Valid @RequestParam(value="configuration",required=false)
 @Valid Boolean _configuration,
 @Valid @RequestParam(value="onlyMandatory",required=false)
 @Valid Boolean onlyMandatory)

GET /rest/status/byNames/sentTo/{subscribers}/{projectName}/{environmentName}/{systemNames} : checkEnvironmentWithSpecifiedSystemsByNamesAndSendNotifications

Parameters:

projectName - projectName (required)

environmentName - environmentName (required)

systemNames - systemNames (required)

subscribers - subscribers (required)

reportSubject - reportSubject (optional)

fail - fail (optional)

warn - warn (optional)

pass - pass (optional)

status - status (optional)

_configuration - configuration (optional)

onlyMandatory - status (optional)

Returns:

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

checkProject

@RequestMapping(method=GET,
                value="/rest/status/timezones/{projectId}",
                produces="application/json")
org.springframework.http.ResponseEntity<List<EnvironmentStatusDto>> checkProject(@PathVariable("projectId")
 String projectId,
 @Valid @RequestParam(value="status",required=false)
 @Valid Boolean status,
 @Valid @RequestParam(value="configuration",required=false)
 @Valid Boolean _configuration)

GET /rest/status/timezones/{projectId} : checkProject

Parameters:

projectId - projectId (required)

status - status (optional)

_configuration - configuration (optional)

Returns:

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

checkSystem

@RequestMapping(method=GET,
                value="/rest/status/system/{projectId}/{environmentId}/{systemId}",
                produces="application/json")
org.springframework.http.ResponseEntity<SystemStatusDto> checkSystem(@PathVariable("projectId")
 String projectId,
 @PathVariable("environmentId")
 String environmentId,
 @PathVariable("systemId")
 String systemId,
 @Valid @RequestParam(value="status",required=false)
 @Valid Boolean status,
 @Valid @RequestParam(value="configuration",required=false)
 @Valid Boolean _configuration,
 @Valid @RequestParam(value="onlyMandatory",required=false)
 @Valid Boolean onlyMandatory)

GET /rest/status/system/{projectId}/{environmentId}/{systemId} : checkSystem

Parameters:

projectId - projectId (required)

environmentId - environmentId (required)

systemId - systemId (required)

status - status (optional)

_configuration - configuration (optional)

onlyMandatory - status (optional)

Returns:

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

mandatoryCheckEnvironments

@RequestMapping(method=GET,
                value="/rest/status/report/{projectId}/{environmentIds}/{executionRequestId}",
                produces="application/json")
org.springframework.http.ResponseEntity<MandatoryStatusesResponseDto> mandatoryCheckEnvironments(@PathVariable("projectId")
 UUID projectId,
 @PathVariable("environmentIds")
 List<UUID> environmentIds,
 @PathVariable("executionRequestId")
 UUID executionRequestId,
 @Valid @RequestParam(value="status",required=false)
 @Valid Boolean status,
 @Valid @RequestParam(value="configuration",required=false)
 @Valid Boolean _configuration)

GET /rest/status/report/{projectId}/{environmentIds}/{executionRequestId} : mandatoryCheckEnvironments

Parameters:

projectId - projectId (required)

environmentIds - environmentIds (required)

executionRequestId - executionRequestId (required)

status - status (optional)

_configuration - configuration (optional)

Returns:

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