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

Interface TestScenarioControllerApi

All Known Subinterfaces:

CatalogueTestScenarioFeignClient

@Generated(value="org.openapitools.codegen.languages.SpringCodegen",
           date="2025-07-10T06:10:28.754468223Z[Etc/UTC]")
@Validated
public interface TestScenarioControllerApi

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<Void>	addCompoundsToTestScenario(UUID uuid, @Valid CompoundBodyRequestDto compoundBodyRequestDto)	POST /catalog/api/v1/testscenarios/{uuid}/compounds : addCompoundsToTestScenario
org.springframework.http.ResponseEntity<CheckSumResponseDto>	checkHashSum(@Valid Map<String,String> requestBody)	POST /catalog/api/v1/testscenarios/checkHashSum : checkHashSum
org.springframework.http.ResponseEntity<TestScenariosCompareResponseDto>	compareTestScenarios(@Valid TestScenariosCompareRequestDto testScenariosCompareRequestDto)	POST /catalog/api/v1/testscenarios/compare : compareTestScenarios
org.springframework.http.ResponseEntity<List<TestScenarioDto>>	copyTestScenarios(@Valid CopyRequestDto copyRequestDto)	POST /catalog/api/v1/testscenarios/copy : copyTestScenarios
org.springframework.http.ResponseEntity<UUID>	create(@Valid SaveEntityRequestTestScenarioDto saveEntityRequestTestScenarioDto)	POST /catalog/api/v1/testscenarios/create : create
org.springframework.http.ResponseEntity<Set<UUID>>	createBulk(@Valid SaveListOfEntityRequestTestScenarioDto saveListOfEntityRequestTestScenarioDto)	POST /catalog/api/v1/testscenarios/create/bulk : createBulk
org.springframework.http.ResponseEntity<TestScenarioDto>	createCompoundFromTestScenario(UUID uuid)	POST /catalog/api/v1/testscenarios/{uuid}/create/compound_from_ts : createCompoundFromTestScenario
org.springframework.http.ResponseEntity<List<TestScenarioDto>>	getAll()	GET /catalog/api/v1/testscenarios : getAll
org.springframework.http.ResponseEntity<List<EnrichedTestScenarioDto>>	getAllEnriched(@NotNull @Valid String includes)	GET /catalog/api/v1/testscenarios/enriched : getAllEnriched
org.springframework.http.ResponseEntity<List<TestScenarioDto>>	getAllNameByProjectId(@NotNull @Valid UUID projectId, @Valid UUID testPlanId)	GET /catalog/api/v1/testscenarios/find-name : getAllNameByProjectId
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/testscenarios/find-name-pagination : getAllNamesByNameWithPagination
org.springframework.http.ResponseEntity<MetaInfoForTestScenarioCompareResponseDto>	getMetaInfoForScenarioCompare(@Valid MetaInfoForCompareRequestDto metaInfoForCompareRequestDto)	POST /catalog/api/v1/testscenarios/compare/editor : getMetaInfoForScenarioCompare
org.springframework.http.ResponseEntity<MetaInfoTreeResponseDto>	getMetaInfoTreeResponse(UUID uuid)	GET /catalog/api/v1/testscenarios/{uuid}/metainfo-tree : getMetaInfoTreeResponse
org.springframework.http.ResponseEntity<TestScenarioEditorResponseDto>	getScenarioBodyForEditor(UUID uuid)	GET /catalog/api/v1/testscenarios/{uuid}/editor : getScenarioBodyForEditor
org.springframework.http.ResponseEntity<List<TestCaseResponseDto>>	getTestCasesLabel(UUID uuid)	GET /catalog/api/v1/testscenarios/{uuid}/testcases : getTestCasesLabel
org.springframework.http.ResponseEntity<TestScenarioDto>	getTestScenarioByUuid(String uuid)	GET /catalog/api/v1/testscenarios/{uuid} : getTestScenarioByUuid
org.springframework.http.ResponseEntity<Void>	moveTestScenarios(@Valid MoveRequestDto moveRequestDto)	POST /catalog/api/v1/testscenarios/move : moveTestScenarios
org.springframework.http.ResponseEntity<TestScenarioDto>	patchUpdate(UUID uuid, @NotNull @Valid UUID projectId, @Valid Boolean rename, @Valid ScenarioPatchUpdateRequestDto scenarioPatchUpdateRequestDto)	PUT /catalog/api/v1/testscenarios/{uuid}/patch : patchUpdate
org.springframework.http.ResponseEntity<UUID>	update(@Valid TestScenarioDto testScenarioDto)	PUT /catalog/api/v1/testscenarios/save : update
org.springframework.http.ResponseEntity<UUID>	updateFromEditor(@Valid TestScenarioEditorResponseDto testScenarioEditorResponseDto)	PUT /catalog/api/v1/testscenarios/editor/save : updateFromEditor

Method Details

addCompoundsToTestScenario

@RequestMapping(method=POST,
                value="/catalog/api/v1/testscenarios/{uuid}/compounds",
                consumes="application/json")
org.springframework.http.ResponseEntity<Void> addCompoundsToTestScenario(@PathVariable("uuid")
 UUID uuid,
 @Valid @RequestBody(required=false)
 @Valid CompoundBodyRequestDto compoundBodyRequestDto)

POST /catalog/api/v1/testscenarios/{uuid}/compounds : addCompoundsToTestScenario

Parameters:

uuid - uuid (required)

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

checkHashSum

@RequestMapping(method=POST,
                value="/catalog/api/v1/testscenarios/checkHashSum",
                produces="application/json",
                consumes="application/json")
org.springframework.http.ResponseEntity<CheckSumResponseDto> checkHashSum(@Valid @RequestBody(required=false)
 @Valid Map<String,String> requestBody)

POST /catalog/api/v1/testscenarios/checkHashSum : checkHashSum

Parameters:

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

compareTestScenarios

@RequestMapping(method=POST,
                value="/catalog/api/v1/testscenarios/compare",
                produces="application/json",
                consumes="application/json")
org.springframework.http.ResponseEntity<TestScenariosCompareResponseDto> compareTestScenarios(@Valid @RequestBody(required=false)
 @Valid TestScenariosCompareRequestDto testScenariosCompareRequestDto)

POST /catalog/api/v1/testscenarios/compare : compareTestScenarios

Parameters:

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

copyTestScenarios

@RequestMapping(method=POST,
                value="/catalog/api/v1/testscenarios/copy",
                produces="application/json",
                consumes="application/json")
org.springframework.http.ResponseEntity<List<TestScenarioDto>> copyTestScenarios(@Valid @RequestBody(required=false)
 @Valid CopyRequestDto copyRequestDto)

POST /catalog/api/v1/testscenarios/copy : copyTestScenarios

Parameters:

copyRequestDto - (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=POST,
                value="/catalog/api/v1/testscenarios/create",
                produces="application/json",
                consumes="application/json")
org.springframework.http.ResponseEntity<UUID> create(@Valid @RequestBody(required=false)
 @Valid SaveEntityRequestTestScenarioDto saveEntityRequestTestScenarioDto)

POST /catalog/api/v1/testscenarios/create : create

Parameters:

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

createBulk

@RequestMapping(method=POST,
                value="/catalog/api/v1/testscenarios/create/bulk",
                produces="application/json",
                consumes="application/json")
org.springframework.http.ResponseEntity<Set<UUID>> createBulk(@Valid @RequestBody(required=false)
 @Valid SaveListOfEntityRequestTestScenarioDto saveListOfEntityRequestTestScenarioDto)

POST /catalog/api/v1/testscenarios/create/bulk : createBulk

Parameters:

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

createCompoundFromTestScenario

@RequestMapping(method=POST,
                value="/catalog/api/v1/testscenarios/{uuid}/create/compound_from_ts",
                produces="application/json")
org.springframework.http.ResponseEntity<TestScenarioDto> createCompoundFromTestScenario(@PathVariable("uuid")
 UUID uuid)

POST /catalog/api/v1/testscenarios/{uuid}/create/compound_from_ts : createCompoundFromTestScenario

Parameters:

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

getAll

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

GET /catalog/api/v1/testscenarios : getAll

Returns:

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

getAllEnriched

@RequestMapping(method=GET,
                value="/catalog/api/v1/testscenarios/enriched",
                produces="application/json")
org.springframework.http.ResponseEntity<List<EnrichedTestScenarioDto>> getAllEnriched(@NotNull @Valid @RequestParam(value="includes",required=true)
 @NotNull @Valid String includes)

GET /catalog/api/v1/testscenarios/enriched : getAllEnriched

Parameters:

includes - includes (required)

Returns:

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

getAllNameByProjectId

@RequestMapping(method=GET,
                value="/catalog/api/v1/testscenarios/find-name",
                produces="application/json")
org.springframework.http.ResponseEntity<List<TestScenarioDto>> getAllNameByProjectId(@NotNull @Valid @RequestParam(value="projectId",required=true)
 @NotNull @Valid UUID projectId,
 @Valid @RequestParam(value="testPlanId",required=false)
 @Valid UUID testPlanId)

GET /catalog/api/v1/testscenarios/find-name : getAllNameByProjectId

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)

getAllNamesByNameWithPagination

@RequestMapping(method=GET,
                value="/catalog/api/v1/testscenarios/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/testscenarios/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)

getMetaInfoForScenarioCompare

@RequestMapping(method=POST,
                value="/catalog/api/v1/testscenarios/compare/editor",
                produces="application/json",
                consumes="application/json")
org.springframework.http.ResponseEntity<MetaInfoForTestScenarioCompareResponseDto> getMetaInfoForScenarioCompare(@Valid @RequestBody(required=false)
 @Valid MetaInfoForCompareRequestDto metaInfoForCompareRequestDto)

POST /catalog/api/v1/testscenarios/compare/editor : getMetaInfoForScenarioCompare

Parameters:

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

getMetaInfoTreeResponse

@RequestMapping(method=GET,
                value="/catalog/api/v1/testscenarios/{uuid}/metainfo-tree",
                produces="application/json")
org.springframework.http.ResponseEntity<MetaInfoTreeResponseDto> getMetaInfoTreeResponse(@PathVariable("uuid")
 UUID uuid)

GET /catalog/api/v1/testscenarios/{uuid}/metainfo-tree : getMetaInfoTreeResponse

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)

getScenarioBodyForEditor

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

GET /catalog/api/v1/testscenarios/{uuid}/editor : getScenarioBodyForEditor

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)

getTestCasesLabel

@RequestMapping(method=GET,
                value="/catalog/api/v1/testscenarios/{uuid}/testcases",
                produces="application/json")
org.springframework.http.ResponseEntity<List<TestCaseResponseDto>> getTestCasesLabel(@PathVariable("uuid")
 UUID uuid)

GET /catalog/api/v1/testscenarios/{uuid}/testcases : getTestCasesLabel

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)

getTestScenarioByUuid

@RequestMapping(method=GET,
                value="/catalog/api/v1/testscenarios/{uuid}",
                produces="application/json")
org.springframework.http.ResponseEntity<TestScenarioDto> getTestScenarioByUuid(@PathVariable("uuid")
 String uuid)

GET /catalog/api/v1/testscenarios/{uuid} : getTestScenarioByUuid

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)

moveTestScenarios

@RequestMapping(method=POST,
                value="/catalog/api/v1/testscenarios/move",
                consumes="application/json")
org.springframework.http.ResponseEntity<Void> moveTestScenarios(@Valid @RequestBody(required=false)
 @Valid MoveRequestDto moveRequestDto)

POST /catalog/api/v1/testscenarios/move : moveTestScenarios

Parameters:

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

patchUpdate

@RequestMapping(method=PUT,
                value="/catalog/api/v1/testscenarios/{uuid}/patch",
                produces="application/json",
                consumes="application/json")
org.springframework.http.ResponseEntity<TestScenarioDto> patchUpdate(@PathVariable("uuid")
 UUID uuid,
 @NotNull @Valid @RequestParam(value="projectId",required=true)
 @NotNull @Valid UUID projectId,
 @Valid @RequestParam(value="rename",required=false)
 @Valid Boolean rename,
 @Valid @RequestBody(required=false)
 @Valid ScenarioPatchUpdateRequestDto scenarioPatchUpdateRequestDto)

PUT /catalog/api/v1/testscenarios/{uuid}/patch : patchUpdate

Parameters:

uuid - uuid (required)

projectId - projectId (required)

rename - rename (optional)

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

update

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

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

Parameters:

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

updateFromEditor

@RequestMapping(method=PUT,
                value="/catalog/api/v1/testscenarios/editor/save",
                produces="application/json",
                consumes="application/json")
org.springframework.http.ResponseEntity<UUID> updateFromEditor(@Valid @RequestBody(required=false)
 @Valid TestScenarioEditorResponseDto testScenarioEditorResponseDto)

PUT /catalog/api/v1/testscenarios/editor/save : updateFromEditor

Parameters:

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