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

Interface TestPlanControllerApi

All Known Subinterfaces:

CatalogueTestPlanFeignClient

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

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<List<TestPlanResponseDto>>	bulkUpdate(@Valid List<TestPlanDto> testPlanDto)	PUT /catalog/api/v1/testplans/bulk : bulkUpdate
org.springframework.http.ResponseEntity<UUID>	cloneTestPlan(@Valid CloneTestPlanRequestDto cloneTestPlanRequestDto)	POST /catalog/api/v1/testplans/clone : cloneTestPlan
org.springframework.http.ResponseEntity<CompareTestPlanQaDslResponseDto>	compareTestPlanQaDsl(@Valid CompareTestPlansRequestDto compareTestPlansRequestDto)	POST /catalog/api/v1/testplans/qadsllibraries/compare : compareTestPlanQaDsl
org.springframework.http.ResponseEntity<CompareTestPlansResponseDto>	compareTestPlans(@Valid CompareTestPlansRequestDto compareTestPlansRequestDto)	POST /catalog/api/v1/testplans/compare : compareTestPlans
org.springframework.http.ResponseEntity<TestPlanResponseDto>	create(@Valid TestPlanDto testPlanDto)	POST /catalog/api/v1/testplans : create
org.springframework.http.ResponseEntity<Void>	delete(UUID uuid)	DELETE /catalog/api/v1/testplans/{uuid} : delete
org.springframework.http.ResponseEntity<List<TestPlanResponseDto>>	getAll()	GET /catalog/api/v1/testplans : getAll
org.springframework.http.ResponseEntity<List<AbstractTestScenarioDto>>	getAllCompoundsAndScenarioCompounds(UUID uuid)	GET /catalog/api/v1/testplans/{uuid}/compounds/compound_from_ts : getAllCompoundsAndScenarioCompounds
org.springframework.http.ResponseEntity<List<CompoundDto>>	getAllCompoundsByTestPlan(UUID uuid)	GET /catalog/api/v1/testplans/{uuid}/compounds : getAllCompoundsByTestPlan
org.springframework.http.ResponseEntity<List<TestScenarioDto>>	getAllCompoundsMadeFromTestScenario(UUID uuid)	GET /catalog/api/v1/testplans/{uuid}/compound_from_ts : getAllCompoundsMadeFromTestScenario
org.springframework.http.ResponseEntity<List<TestCaseGroupDto>>	getAllNameByTestPlanId(UUID uuid)	GET /catalog/api/v1/testplans/{uuid}/testcasegroups/short : getAllNameByTestPlanId
org.springframework.http.ResponseEntity<List<DslDependencyNodeDto>>	getDslDependencies(UUID uuid)	GET /catalog/api/v1/testplans/{uuid}/dslDependencies : getDslDependencies
org.springframework.http.ResponseEntity<TestPlanDslMappingsResponseDto>	getDslMappings(UUID testPlanId, @Valid TestPlanDslMappingsRequestDto testPlanDslMappingsRequestDto)	POST /catalog/api/v1/testplans/{testPlanId}/dslMappings : getDslMappings
org.springframework.http.ResponseEntity<TestPlanEntitiesResponseDto>	getEntitiesForCopyByTestPlan(UUID uuid)	GET /catalog/api/v1/testplans/{uuid}/enriched : getEntitiesForCopyByTestPlan
org.springframework.http.ResponseEntity<List<LabelDto>>	getLabelsByTestPlanId(UUID uuid)	GET /catalog/api/v1/testplans/{uuid}/labels : getLabelsByTestPlanId
org.springframework.http.ResponseEntity<List<LogCollectorConditionDto>>	getLogCollectorConditionByTestPlan(UUID uuid)	GET /catalog/api/v1/testplans/{uuid}/logcollectorconditions : getLogCollectorConditionByTestPlan
org.springframework.http.ResponseEntity<List<TestCaseGroupDto>>	getTestCaseGroupedByTestPlanId(UUID uuid)	GET /catalog/api/v1/testplans/{uuid}/testcasegroups : getTestCaseGroupedByTestPlanId
org.springframework.http.ResponseEntity<List<TestCaseDto>>	getTestCasesByTestPlanId(UUID uuid)	GET /catalog/api/v1/testplans/{uuid}/testcases : getTestCasesByTestPlanId
org.springframework.http.ResponseEntity<TestPlanDtoDto>	getTestPlanByUuid(UUID uuid)	GET /catalog/api/v1/testplans/{uuid} : getTestPlanByUuid
org.springframework.http.ResponseEntity<QaDslLibraryDto>	getTestPlanQaDslLibrary(UUID uuid)	GET /catalog/api/v1/testplans/{uuid}/qadsllibrary : getTestPlanQaDslLibrary
org.springframework.http.ResponseEntity<List<TestScopeDto>>	getTestScopesByTestPlanId(UUID uuid)	GET /catalog/api/v1/testplans/{uuid}/testscopes : getTestScopesByTestPlanId
org.springframework.http.ResponseEntity<List<TestScopeFullInfoDto>>	getTestScopesFullInfoByTestPlanUuid(UUID uuid)	GET /catalog/api/v1/testplans/{uuid}/testscopes/enriched : getTestScopesFullInfoByTestPlanUuid
org.springframework.http.ResponseEntity<Void>	patch(@Valid List<TestPlanDto> testPlanDto)	PATCH /catalog/api/v1/testplans : patch
org.springframework.http.ResponseEntity<UUID>	patchUpdate(@Valid TestPlanDto testPlanDto)	PUT /catalog/api/v1/testplans/patch : patchUpdate
org.springframework.http.ResponseEntity<UUID>	update(@Valid TestPlanDto testPlanDto)	PUT /catalog/api/v1/testplans : update
org.springframework.http.ResponseEntity<UUID>	updateQaDslLibraryField(@Valid TestPlanDto testPlanDto)	PUT /catalog/api/v1/testplans/update-qa-dsl : updateQaDslLibraryField

Method Details

bulkUpdate

@RequestMapping(method=PUT,
                value="/catalog/api/v1/testplans/bulk",
                produces="application/json",
                consumes="application/json")
org.springframework.http.ResponseEntity<List<TestPlanResponseDto>> bulkUpdate(@Valid @RequestBody(required=false)
 @Valid List<TestPlanDto> testPlanDto)

PUT /catalog/api/v1/testplans/bulk : bulkUpdate

Parameters:

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

cloneTestPlan

@RequestMapping(method=POST,
                value="/catalog/api/v1/testplans/clone",
                produces="application/json",
                consumes="application/json")
org.springframework.http.ResponseEntity<UUID> cloneTestPlan(@Valid @RequestBody(required=false)
 @Valid CloneTestPlanRequestDto cloneTestPlanRequestDto)

POST /catalog/api/v1/testplans/clone : cloneTestPlan

Parameters:

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

compareTestPlanQaDsl

@RequestMapping(method=POST,
                value="/catalog/api/v1/testplans/qadsllibraries/compare",
                produces="application/json",
                consumes="application/json")
org.springframework.http.ResponseEntity<CompareTestPlanQaDslResponseDto> compareTestPlanQaDsl(@Valid @RequestBody(required=false)
 @Valid CompareTestPlansRequestDto compareTestPlansRequestDto)

POST /catalog/api/v1/testplans/qadsllibraries/compare : compareTestPlanQaDsl

Parameters:

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

compareTestPlans

@RequestMapping(method=POST,
                value="/catalog/api/v1/testplans/compare",
                produces="application/json",
                consumes="application/json")
org.springframework.http.ResponseEntity<CompareTestPlansResponseDto> compareTestPlans(@Valid @RequestBody(required=false)
 @Valid CompareTestPlansRequestDto compareTestPlansRequestDto)

POST /catalog/api/v1/testplans/compare : compareTestPlans

Parameters:

compareTestPlansRequestDto - (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/testplans",
                produces="application/json",
                consumes="application/json")
org.springframework.http.ResponseEntity<TestPlanResponseDto> create(@Valid @RequestBody(required=false)
 @Valid TestPlanDto testPlanDto)

POST /catalog/api/v1/testplans : create

Parameters:

testPlanDto - (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/testplans/{uuid}")
org.springframework.http.ResponseEntity<Void> delete(@PathVariable("uuid")
 UUID uuid)

DELETE /catalog/api/v1/testplans/{uuid} : delete

Parameters:

uuid - uuid (required)

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/testplans",
                produces="application/json")
org.springframework.http.ResponseEntity<List<TestPlanResponseDto>> getAll()

GET /catalog/api/v1/testplans : getAll

Returns:

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

getAllCompoundsAndScenarioCompounds

@RequestMapping(method=GET,
                value="/catalog/api/v1/testplans/{uuid}/compounds/compound_from_ts",
                produces="application/json")
org.springframework.http.ResponseEntity<List<AbstractTestScenarioDto>> getAllCompoundsAndScenarioCompounds(@PathVariable("uuid")
 UUID uuid)

GET /catalog/api/v1/testplans/{uuid}/compounds/compound_from_ts : getAllCompoundsAndScenarioCompounds

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)

getAllCompoundsByTestPlan

@RequestMapping(method=GET,
                value="/catalog/api/v1/testplans/{uuid}/compounds",
                produces="application/json")
org.springframework.http.ResponseEntity<List<CompoundDto>> getAllCompoundsByTestPlan(@PathVariable("uuid")
 UUID uuid)

GET /catalog/api/v1/testplans/{uuid}/compounds : getAllCompoundsByTestPlan

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)

getAllCompoundsMadeFromTestScenario

@RequestMapping(method=GET,
                value="/catalog/api/v1/testplans/{uuid}/compound_from_ts",
                produces="application/json")
org.springframework.http.ResponseEntity<List<TestScenarioDto>> getAllCompoundsMadeFromTestScenario(@PathVariable("uuid")
 UUID uuid)

GET /catalog/api/v1/testplans/{uuid}/compound_from_ts : getAllCompoundsMadeFromTestScenario

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)

getAllNameByTestPlanId

@RequestMapping(method=GET,
                value="/catalog/api/v1/testplans/{uuid}/testcasegroups/short",
                produces="application/json")
org.springframework.http.ResponseEntity<List<TestCaseGroupDto>> getAllNameByTestPlanId(@PathVariable("uuid")
 UUID uuid)

GET /catalog/api/v1/testplans/{uuid}/testcasegroups/short : getAllNameByTestPlanId

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)

getDslDependencies

@RequestMapping(method=GET,
                value="/catalog/api/v1/testplans/{uuid}/dslDependencies",
                produces="application/json")
org.springframework.http.ResponseEntity<List<DslDependencyNodeDto>> getDslDependencies(@PathVariable("uuid")
 UUID uuid)

GET /catalog/api/v1/testplans/{uuid}/dslDependencies : getDslDependencies

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)

getDslMappings

@RequestMapping(method=POST,
                value="/catalog/api/v1/testplans/{testPlanId}/dslMappings",
                produces="application/json",
                consumes="application/json")
org.springframework.http.ResponseEntity<TestPlanDslMappingsResponseDto> getDslMappings(@PathVariable("testPlanId")
 UUID testPlanId,
 @Valid @RequestBody(required=false)
 @Valid TestPlanDslMappingsRequestDto testPlanDslMappingsRequestDto)

POST /catalog/api/v1/testplans/{testPlanId}/dslMappings : getDslMappings

Parameters:

testPlanId - (required)

testPlanDslMappingsRequestDto - (optional)

Returns:

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

getEntitiesForCopyByTestPlan

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

GET /catalog/api/v1/testplans/{uuid}/enriched : getEntitiesForCopyByTestPlan

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)

getLabelsByTestPlanId

@RequestMapping(method=GET,
                value="/catalog/api/v1/testplans/{uuid}/labels",
                produces="application/json")
org.springframework.http.ResponseEntity<List<LabelDto>> getLabelsByTestPlanId(@PathVariable("uuid")
 UUID uuid)

GET /catalog/api/v1/testplans/{uuid}/labels : getLabelsByTestPlanId

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)

getLogCollectorConditionByTestPlan

@RequestMapping(method=GET,
                value="/catalog/api/v1/testplans/{uuid}/logcollectorconditions",
                produces="application/json")
org.springframework.http.ResponseEntity<List<LogCollectorConditionDto>> getLogCollectorConditionByTestPlan(@PathVariable("uuid")
 UUID uuid)

GET /catalog/api/v1/testplans/{uuid}/logcollectorconditions : getLogCollectorConditionByTestPlan

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)

getTestCaseGroupedByTestPlanId

@RequestMapping(method=GET,
                value="/catalog/api/v1/testplans/{uuid}/testcasegroups",
                produces="application/json")
org.springframework.http.ResponseEntity<List<TestCaseGroupDto>> getTestCaseGroupedByTestPlanId(@PathVariable("uuid")
 UUID uuid)

GET /catalog/api/v1/testplans/{uuid}/testcasegroups : getTestCaseGroupedByTestPlanId

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)

getTestCasesByTestPlanId

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

GET /catalog/api/v1/testplans/{uuid}/testcases : getTestCasesByTestPlanId

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)

getTestPlanByUuid

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

GET /catalog/api/v1/testplans/{uuid} : getTestPlanByUuid

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)

getTestPlanQaDslLibrary

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

GET /catalog/api/v1/testplans/{uuid}/qadsllibrary : getTestPlanQaDslLibrary

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)

getTestScopesByTestPlanId

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

GET /catalog/api/v1/testplans/{uuid}/testscopes : getTestScopesByTestPlanId

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)

getTestScopesFullInfoByTestPlanUuid

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

GET /catalog/api/v1/testplans/{uuid}/testscopes/enriched : getTestScopesFullInfoByTestPlanUuid

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)

patch

@RequestMapping(method=PATCH,
                value="/catalog/api/v1/testplans",
                consumes="application/json")
org.springframework.http.ResponseEntity<Void> patch(@Valid @RequestBody(required=false)
 @Valid List<TestPlanDto> testPlanDto)

PATCH /catalog/api/v1/testplans : patch

Parameters:

testPlanDto - (optional)

Returns:

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

patchUpdate

@RequestMapping(method=PUT,
                value="/catalog/api/v1/testplans/patch",
                produces="application/json",
                consumes="application/json")
org.springframework.http.ResponseEntity<UUID> patchUpdate(@Valid @RequestBody(required=false)
 @Valid TestPlanDto testPlanDto)

PUT /catalog/api/v1/testplans/patch : patchUpdate

Parameters:

testPlanDto - (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/testplans",
                produces="application/json",
                consumes="application/json")
org.springframework.http.ResponseEntity<UUID> update(@Valid @RequestBody(required=false)
 @Valid TestPlanDto testPlanDto)

PUT /catalog/api/v1/testplans : update

Parameters:

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

updateQaDslLibraryField

@RequestMapping(method=PUT,
                value="/catalog/api/v1/testplans/update-qa-dsl",
                produces="application/json",
                consumes="application/json")
org.springframework.http.ResponseEntity<UUID> updateQaDslLibraryField(@Valid @RequestBody(required=false)
 @Valid TestPlanDto testPlanDto)

PUT /catalog/api/v1/testplans/update-qa-dsl : updateQaDslLibraryField

Parameters:

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