Package org.qubership.atp.dataset.controllers.api

Interface VisibilityAreaControllerApi

@Generated(value="org.openapitools.codegen.languages.SpringCodegen",
           date="2025-09-30T20:29:54.191499410Z[Etc/UTC]")
@Validated
public interface VisibilityAreaControllerApi

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<Void>	copyToVisibilityArea(UUID visibilityAreaId, @Valid UUID body)	POST /va/{visibilityAreaId}/copyTo : Copy DSL with name provided.
org.springframework.http.ResponseEntity<UUID>	create(@NotNull @Valid 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, @NotNull @Valid String name)	POST /va/{visibilityAreaId} : Renames selected VA.

Method Details

copyToVisibilityArea

@RequestMapping(method=POST,
                value="/va/{visibilityAreaId}/copyTo",
                consumes="application/json")
org.springframework.http.ResponseEntity<Void> copyToVisibilityArea(@PathVariable("visibilityAreaId")
 UUID visibilityAreaId,
 @Valid @RequestBody(required=false)
 @Valid 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 @Valid @RequestParam(value="name",required=true)
 @NotNull @Valid 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("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("visibilityAreaId")
 UUID visibilityAreaId,
 @NotNull @Valid @RequestParam(value="name",required=true)
 @NotNull @Valid 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)