VisibilityAreaControllerApi (org.qubership.atp:atp-itf-core 4.4.107 API)

All Known Subinterfaces:: DatasetsVisibilityAreaFeignClient

@Generated(value="org.openapitools.codegen.languages.SpringCodegen",
           date="2025-06-19T14:15:27.879Z[Etc/UTC]")
 @Validated
public interface VisibilityAreaControllerApi

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`org.springframework.http.ResponseEntity<Void>`	`copyToVisibilityArea(UUID visibilityAreaId, UUID body)` POST /va/{visibilityAreaId}/copyTo : Copy DSL with name provided.
`org.springframework.http.ResponseEntity<UUID>`	`create(String name)` PUT /va : Creates new visibility area with provided name and order.
`org.springframework.http.ResponseEntity<Void>`	`delete(UUID visibilityAreaId)` DELETE /va/{visibilityAreaId} : Deletes selected VA.
`org.springframework.http.ResponseEntity<List<VisibilityAreaFlatModelDto>>`	`getVisibilityAreas()` GET /va : Returns all visibility areas.
`org.springframework.http.ResponseEntity<List<VisibilityAreaFlatModelDto>>`	`getVisibilityAreasSorted()` GET /va/sorted : Returns all visibility areas sorted by name.
`org.springframework.http.ResponseEntity<Boolean>`	`rename(UUID visibilityAreaId, String name)` POST /va/{visibilityAreaId} : Renames selected VA.

Method Detail

copyToVisibilityArea

@RequestMapping(method=POST,
                value="/va/{visibilityAreaId}/copyTo",
                consumes="application/json")
org.springframework.http.ResponseEntity<Void> copyToVisibilityArea(@PathVariable(value="visibilityAreaId")
                                                                                                                                                                                                    UUID visibilityAreaId,
                                                                                                                                                                                                    @RequestBody(required=false)
                                                                                                                                                                                                    UUID body)

POST /va/{visibilityAreaId}/copyTo : Copy DSL with name provided.

Parameters:: visibilityAreaId - visibilityAreaId (required); body - (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)

create

@RequestMapping(method=PUT,
                value="/va",
                produces="application/json")
org.springframework.http.ResponseEntity<UUID> create(@NotNull @RequestParam(value="name",required=true)
                                                                                                                                                           String name)

PUT /va : Creates new visibility area with provided name and order.

Parameters:: name - name (required)
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)

delete

@RequestMapping(method=DELETE,
                value="/va/{visibilityAreaId}")
org.springframework.http.ResponseEntity<Void> delete(@PathVariable(value="visibilityAreaId")
                                                                                                                                    UUID visibilityAreaId)

DELETE /va/{visibilityAreaId} : Deletes selected VA.

Parameters:: visibilityAreaId - visibilityAreaId (required)
Returns:: No Content (status code 204) or Unauthorized (status code 401) or Forbidden (status code 403)

getVisibilityAreas
```
@RequestMapping(method=GET,
                value="/va",
                produces="application/json")
org.springframework.http.ResponseEntity<List<VisibilityAreaFlatModelDto>> getVisibilityAreas()
```
GET /va : Returns all visibility areas.

Returns:

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

getVisibilityAreasSorted
```
@RequestMapping(method=GET,
                value="/va/sorted",
                produces="application/json")
org.springframework.http.ResponseEntity<List<VisibilityAreaFlatModelDto>> getVisibilityAreasSorted()
```
GET /va/sorted : Returns all visibility areas sorted by name.

Returns:

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

rename

@RequestMapping(method=POST,
                value="/va/{visibilityAreaId}",
                produces="application/json")
org.springframework.http.ResponseEntity<Boolean> rename(@PathVariable(value="visibilityAreaId")
                                                                                                                                                                                  UUID visibilityAreaId,
                                                                                                                                                                                  @NotNull @RequestParam(value="name",required=true)
                                                                                                                                                                                  String name)

POST /va/{visibilityAreaId} : Renames selected VA.

Parameters:: visibilityAreaId - visibilityAreaId (required); name - name (required)
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)

Interface VisibilityAreaControllerApi