Package org.qubership.atp.ram.clients.api

Interface TestScopeControllerApi

All Known Subinterfaces:

CatalogueTestScopeFeignClient

@Generated(value="org.openapitools.codegen.languages.SpringCodegen",
           date="2025-10-03T13:16:57.458750146Z[Etc/UTC]")
@Validated
public interface TestScopeControllerApi

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<UUID>	addExecutionCases(UUID uuid, @Valid TestScopeDto testScopeDto)	PUT /catalog/api/v1/testscopes/{uuid}/testcases/save : addExecutionCases
org.springframework.http.ResponseEntity<CheckTestScopeUniquenessResponseDto>	checkUniquenessByName(@Valid CheckTestScopeUniquenessRequestDto checkTestScopeUniquenessRequestDto)	POST /catalog/api/v1/testscopes/checkUniquenessByName : checkUniquenessByName
org.springframework.http.ResponseEntity<Void>	copyTestScopes(@Valid TestScopesCopyRequestDto testScopesCopyRequestDto)	GET /catalog/api/v1/testscopes/copy : copyTestScopes
org.springframework.http.ResponseEntity<UUID>	create(@Valid TestScopeCreationRequestDto testScopeCreationRequestDto)	POST /catalog/api/v1/testscopes/create : create
org.springframework.http.ResponseEntity<Void>	delete(@Valid Set<UUID> UUID)	DELETE /catalog/api/v1/testscopes : delete
org.springframework.http.ResponseEntity<List<TestScopeDto>>	getAll()	GET /catalog/api/v1/testscopes : getAll
org.springframework.http.ResponseEntity<PageAbstractEntityResponseDto>	getAllNamesByNameWithPagination(@NotNull @Valid UUID projectId, @NotNull @Valid UUID testPlanId, @NotNull @Valid String name, @Valid Long offset, @Valid Integer pageNumber, @Valid Integer pageSize, @Valid Boolean paged, @Valid Boolean sortSorted, @Valid Boolean sortUnsorted, @Valid Boolean unpaged)	GET /catalog/api/v1/testscopes/find-name-pagination : getAllNamesByNameWithPagination
org.springframework.http.ResponseEntity<Long>	getCountTestScopeDetailed(@NotNull @Valid UUID projectId, @Valid UUID testPlanId)	GET /catalog/api/v1/testscopes/detailed/count : getCountTestScopeDetailed
org.springframework.http.ResponseEntity<Void>	getCsvImportSampleFile()	GET /catalog/api/v1/testscopes/import/csv/sample : getCsvImportSampleFile
org.springframework.http.ResponseEntity<Set<UUID>>	getDatasetsFromScopes(@Valid Set<UUID> UUID)	POST /catalog/api/v1/testscopes/datasetsFromScopes : getDatasetsFromScopes
org.springframework.http.ResponseEntity<DetailedTestScopeResponseDto>	getDetailedScope(UUID testScopeId, @Valid UUID testPlanId)	GET /catalog/api/v1/testscopes/{testScopeId}/detailed : getDetailedScope
org.springframework.http.ResponseEntity<EnrichedScopeDto>	getEnrichedScope(UUID uuid)	GET /catalog/api/v1/testscopes/{uuid}/enriched : getEnrichedScope
org.springframework.http.ResponseEntity<TestScopeDto>	getTestScopeByUuid(UUID uuid)	GET /catalog/api/v1/testscopes/{uuid} : getTestScopeByUuid
org.springframework.http.ResponseEntity<List<TestScopeFullInfoDto>>	getTestScopesDetailed(@NotNull @Valid UUID projectId, @Valid UUID testPlanId)	GET /catalog/api/v1/testscopes/detailed : getTestScopesDetailed
org.springframework.http.ResponseEntity<List<TestScopeFullInfoDto>>	getTestScopesDetailedPaging(@NotNull @Valid UUID projectId, Integer startIndex, Integer endIndex, @Valid UUID testPlanId)	GET /catalog/api/v1/testscopes/detailed/start-index/{startIndex}/end-index/{endIndex} : getTestScopesDetailedPaging
org.springframework.http.ResponseEntity<UUID>	importTestScopeFromCsv(@NotNull @Valid String testScopeName, @NotNull @Valid UUID testPlanId, @NotNull @Valid UUID projectId, @Valid Object file)	POST /catalog/api/v1/testscopes/import/csv : importTestScopeFromCsv
org.springframework.http.ResponseEntity<UUID>	update(@Valid TestScopeDto testScopeDto)	PUT /catalog/api/v1/testscopes/save : update
org.springframework.http.ResponseEntity<DetailedTestScopeResponseDto>	updateDetailed(@Valid TestScopeUpdateRequestDto testScopeUpdateRequestDto)	PUT /catalog/api/v1/testscopes/save/detailed : updateDetailed
org.springframework.http.ResponseEntity<EnrichedScopeDto>	updateEnriched(@Valid TestScopeDto testScopeDto)	PUT /catalog/api/v1/testscopes/save/enriched : updateEnriched
org.springframework.http.ResponseEntity<TestScopeDto>	updateShort(@Valid TestScopeUpdateShortRequestDto testScopeUpdateShortRequestDto)	PUT /catalog/api/v1/testscopes/save/short : updateShort

Method Details

addExecutionCases

@RequestMapping(method=PUT,
                value="/catalog/api/v1/testscopes/{uuid}/testcases/save",
                produces="application/json",
                consumes="application/json")
org.springframework.http.ResponseEntity<UUID> addExecutionCases(@PathVariable("uuid")
 UUID uuid,
 @Valid @RequestBody(required=false)
 @Valid TestScopeDto testScopeDto)

PUT /catalog/api/v1/testscopes/{uuid}/testcases/save : addExecutionCases

Parameters:

uuid - uuid (required)

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

checkUniquenessByName

@RequestMapping(method=POST,
                value="/catalog/api/v1/testscopes/checkUniquenessByName",
                produces="application/json",
                consumes="application/json")
org.springframework.http.ResponseEntity<CheckTestScopeUniquenessResponseDto> checkUniquenessByName(@Valid @RequestBody(required=false)
 @Valid CheckTestScopeUniquenessRequestDto checkTestScopeUniquenessRequestDto)

POST /catalog/api/v1/testscopes/checkUniquenessByName : checkUniquenessByName

Parameters:

checkTestScopeUniquenessRequestDto - (optional)

Returns:

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

copyTestScopes

@RequestMapping(method=GET,
                value="/catalog/api/v1/testscopes/copy",
                consumes="application/json")
org.springframework.http.ResponseEntity<Void> copyTestScopes(@Valid @RequestBody(required=false)
 @Valid TestScopesCopyRequestDto testScopesCopyRequestDto)

GET /catalog/api/v1/testscopes/copy : copyTestScopes

Parameters:

testScopesCopyRequestDto - (optional)

Returns:

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

create

@RequestMapping(method=POST,
                value="/catalog/api/v1/testscopes/create",
                produces="application/json",
                consumes="application/json")
org.springframework.http.ResponseEntity<UUID> create(@Valid @RequestBody(required=false)
 @Valid TestScopeCreationRequestDto testScopeCreationRequestDto)

POST /catalog/api/v1/testscopes/create : create

Parameters:

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

delete

@RequestMapping(method=DELETE,
                value="/catalog/api/v1/testscopes",
                consumes="application/json")
org.springframework.http.ResponseEntity<Void> delete(@Valid @RequestBody(required=false)
 @Valid Set<UUID> UUID)

DELETE /catalog/api/v1/testscopes : delete

Parameters:

UUID - (optional)

Returns:

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

getAll

@RequestMapping(method=GET,
                value="/catalog/api/v1/testscopes",
                produces="application/json")
org.springframework.http.ResponseEntity<List<TestScopeDto>> getAll()

GET /catalog/api/v1/testscopes : getAll

Returns:

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

getAllNamesByNameWithPagination

@RequestMapping(method=GET,
                value="/catalog/api/v1/testscopes/find-name-pagination",
                produces="application/json")
org.springframework.http.ResponseEntity<PageAbstractEntityResponseDto> getAllNamesByNameWithPagination(@NotNull @Valid @RequestParam(value="projectId",required=true)
 @NotNull @Valid UUID projectId,
 @NotNull @Valid @RequestParam(value="testPlanId",required=true)
 @NotNull @Valid UUID testPlanId,
 @NotNull @Valid @RequestParam(value="name",required=true)
 @NotNull @Valid String name,
 @Valid @RequestParam(value="offset",required=false)
 @Valid Long offset,
 @Valid @RequestParam(value="pageNumber",required=false)
 @Valid Integer pageNumber,
 @Valid @RequestParam(value="pageSize",required=false)
 @Valid Integer pageSize,
 @Valid @RequestParam(value="paged",required=false)
 @Valid Boolean paged,
 @Valid @RequestParam(value="sort.sorted",required=false)
 @Valid Boolean sortSorted,
 @Valid @RequestParam(value="sort.unsorted",required=false)
 @Valid Boolean sortUnsorted,
 @Valid @RequestParam(value="unpaged",required=false)
 @Valid Boolean unpaged)

GET /catalog/api/v1/testscopes/find-name-pagination : getAllNamesByNameWithPagination

Parameters:

projectId - projectId (required)

testPlanId - testPlanId (required)

name - name (required)

offset - (optional)

pageNumber - (optional)

pageSize - (optional)

paged - (optional)

sortSorted - (optional)

sortUnsorted - (optional)

unpaged - (optional)

Returns:

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

getCountTestScopeDetailed

@RequestMapping(method=GET,
                value="/catalog/api/v1/testscopes/detailed/count",
                produces="application/json")
org.springframework.http.ResponseEntity<Long> getCountTestScopeDetailed(@NotNull @Valid @RequestParam(value="projectId",required=true)
 @NotNull @Valid UUID projectId,
 @Valid @RequestParam(value="testPlanId",required=false)
 @Valid UUID testPlanId)

GET /catalog/api/v1/testscopes/detailed/count : getCountTestScopeDetailed

Parameters:

projectId - projectId (required)

testPlanId - testPlanId (optional)

Returns:

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

getCsvImportSampleFile

@RequestMapping(method=GET,
                value="/catalog/api/v1/testscopes/import/csv/sample")
org.springframework.http.ResponseEntity<Void> getCsvImportSampleFile()

GET /catalog/api/v1/testscopes/import/csv/sample : getCsvImportSampleFile

Returns:

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

getDatasetsFromScopes

@RequestMapping(method=POST,
                value="/catalog/api/v1/testscopes/datasetsFromScopes",
                produces="application/json",
                consumes="application/json")
org.springframework.http.ResponseEntity<Set<UUID>> getDatasetsFromScopes(@Valid @RequestBody(required=false)
 @Valid Set<UUID> UUID)

POST /catalog/api/v1/testscopes/datasetsFromScopes : getDatasetsFromScopes

Parameters:

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

getDetailedScope

@RequestMapping(method=GET,
                value="/catalog/api/v1/testscopes/{testScopeId}/detailed",
                produces="application/json")
org.springframework.http.ResponseEntity<DetailedTestScopeResponseDto> getDetailedScope(@PathVariable("testScopeId")
 UUID testScopeId,
 @Valid @RequestParam(value="testPlanId",required=false)
 @Valid UUID testPlanId)

GET /catalog/api/v1/testscopes/{testScopeId}/detailed : getDetailedScope

Parameters:

testScopeId - uuid (required)

testPlanId - testPlanId (optional)

Returns:

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

getEnrichedScope

@RequestMapping(method=GET,
                value="/catalog/api/v1/testscopes/{uuid}/enriched",
                produces="application/json")
org.springframework.http.ResponseEntity<EnrichedScopeDto> getEnrichedScope(@PathVariable("uuid")
 UUID uuid)

GET /catalog/api/v1/testscopes/{uuid}/enriched : getEnrichedScope

Parameters:

uuid - uuid (required)

Returns:

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

getTestScopeByUuid

@RequestMapping(method=GET,
                value="/catalog/api/v1/testscopes/{uuid}",
                produces="application/json")
org.springframework.http.ResponseEntity<TestScopeDto> getTestScopeByUuid(@PathVariable("uuid")
 UUID uuid)

GET /catalog/api/v1/testscopes/{uuid} : getTestScopeByUuid

Parameters:

uuid - uuid (required)

Returns:

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

getTestScopesDetailed

@RequestMapping(method=GET,
                value="/catalog/api/v1/testscopes/detailed",
                produces="application/json")
org.springframework.http.ResponseEntity<List<TestScopeFullInfoDto>> getTestScopesDetailed(@NotNull @Valid @RequestParam(value="projectId",required=true)
 @NotNull @Valid UUID projectId,
 @Valid @RequestParam(value="testPlanId",required=false)
 @Valid UUID testPlanId)

GET /catalog/api/v1/testscopes/detailed : getTestScopesDetailed

Parameters:

projectId - projectId (required)

testPlanId - testPlanId (optional)

Returns:

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

getTestScopesDetailedPaging

@RequestMapping(method=GET,
                value="/catalog/api/v1/testscopes/detailed/start-index/{startIndex}/end-index/{endIndex}",
                produces="application/json")
org.springframework.http.ResponseEntity<List<TestScopeFullInfoDto>> getTestScopesDetailedPaging(@NotNull @Valid @RequestParam(value="projectId",required=true)
 @NotNull @Valid UUID projectId,
 @PathVariable("startIndex")
 Integer startIndex,
 @PathVariable("endIndex")
 Integer endIndex,
 @Valid @RequestParam(value="testPlanId",required=false)
 @Valid UUID testPlanId)

GET /catalog/api/v1/testscopes/detailed/start-index/{startIndex}/end-index/{endIndex} : getTestScopesDetailedPaging

Parameters:

projectId - projectId (required)

startIndex - startIndex (required)

endIndex - endIndex (required)

testPlanId - testPlanId (optional)

Returns:

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

importTestScopeFromCsv

@RequestMapping(method=POST,
                value="/catalog/api/v1/testscopes/import/csv",
                produces="application/json",
                consumes="multipart/form-data")
org.springframework.http.ResponseEntity<UUID> importTestScopeFromCsv(@NotNull @Valid @RequestParam(value="testScopeName",required=true)
 @NotNull @Valid String testScopeName,
 @NotNull @Valid @RequestParam(value="testPlanId",required=true)
 @NotNull @Valid UUID testPlanId,
 @NotNull @Valid @RequestParam(value="projectId",required=true)
 @NotNull @Valid UUID projectId,
 @Valid @RequestParam(value="file",required=false)
 @Valid Object file)

POST /catalog/api/v1/testscopes/import/csv : importTestScopeFromCsv

Parameters:

testScopeName - testScopeName (required)

testPlanId - testPlanId (required)

projectId - projectId (required)

file - (optional)

Returns:

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

update

@RequestMapping(method=PUT,
                value="/catalog/api/v1/testscopes/save",
                produces="application/json",
                consumes="application/json")
org.springframework.http.ResponseEntity<UUID> update(@Valid @RequestBody(required=false)
 @Valid TestScopeDto testScopeDto)

PUT /catalog/api/v1/testscopes/save : update

Parameters:

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

updateDetailed

@RequestMapping(method=PUT,
                value="/catalog/api/v1/testscopes/save/detailed",
                produces="application/json",
                consumes="application/json")
org.springframework.http.ResponseEntity<DetailedTestScopeResponseDto> updateDetailed(@Valid @RequestBody(required=false)
 @Valid TestScopeUpdateRequestDto testScopeUpdateRequestDto)

PUT /catalog/api/v1/testscopes/save/detailed : updateDetailed

Parameters:

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

updateEnriched

@RequestMapping(method=PUT,
                value="/catalog/api/v1/testscopes/save/enriched",
                produces="application/json",
                consumes="application/json")
org.springframework.http.ResponseEntity<EnrichedScopeDto> updateEnriched(@Valid @RequestBody(required=false)
 @Valid TestScopeDto testScopeDto)

PUT /catalog/api/v1/testscopes/save/enriched : updateEnriched

Parameters:

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

updateShort

@RequestMapping(method=PUT,
                value="/catalog/api/v1/testscopes/save/short",
                produces="application/json",
                consumes="application/json")
org.springframework.http.ResponseEntity<TestScopeDto> updateShort(@Valid @RequestBody(required=false)
 @Valid TestScopeUpdateShortRequestDto testScopeUpdateShortRequestDto)

PUT /catalog/api/v1/testscopes/save/short : updateShort

Parameters:

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