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

Interface TestCaseControllerApi

All Known Subinterfaces:
CatalogueTestCaseFeignClient
@Generated(value="org.openapitools.codegen.languages.SpringCodegen", date="2025-10-03T13:16:56.491719164Z[Etc/UTC]") @Validated public interface TestCaseControllerApi

  • Method Details

    • addLabelsToTestCases

      @RequestMapping(method=POST, value="/catalog/api/v1/testcases/labels", consumes="application/json") org.springframework.http.ResponseEntity<Void> addLabelsToTestCases(@Valid @RequestBody(required=false) @Valid LabelsRequestDto labelsRequestDto)
      POST /catalog/api/v1/testcases/labels : addLabelsToTestCases
      Parameters:
      labelsRequestDto - (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)

    • bulkCopyTestCasesWhileTestPlansCompare

      @RequestMapping(method=POST, value="/catalog/api/v1/testcases/compare/copy/bulk", consumes="application/json") org.springframework.http.ResponseEntity<Void> bulkCopyTestCasesWhileTestPlansCompare(@Valid @RequestBody(required=false) @Valid CompareCopyRequestDto compareCopyRequestDto)
      POST /catalog/api/v1/testcases/compare/copy/bulk : bulkCopyTestCasesWhileTestPlansCompare
      Parameters:
      compareCopyRequestDto - (optional)
      Returns:
      OK (status code 200) or Unauthorized (status code 401) or Forbidden (status code 403) or Not Found (status code 404)

    • calculateDependencies

      @RequestMapping(method=POST, value="/catalog/api/v1/testcases/calculate-dependencies", produces="application/json") org.springframework.http.ResponseEntity<TestCaseDependenciesResponseDto> calculateDependencies(@NotNull @Valid @RequestParam(value="dataSetId",required=true) @NotNull @Valid UUID dataSetId)
      POST /catalog/api/v1/testcases/calculate-dependencies : calculateDependencies
      Parameters:
      dataSetId - dataSetId (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)

    • compareTestCasesDatasets

      @RequestMapping(method=POST, value="/catalog/api/v1/testcases/datasets/compare", produces="application/json", consumes="application/json") org.springframework.http.ResponseEntity<CompareTestCasesDatasetsResponseDto> compareTestCasesDatasets(@Valid @RequestBody(required=false) @Valid CompareTestCasesDatasetsRequestDto compareTestCasesDatasetsRequestDto)
      POST /catalog/api/v1/testcases/datasets/compare : compareTestCasesDatasets
      Parameters:
      compareTestCasesDatasetsRequestDto - (optional)
      Returns:
      OK (status code 200) or Unauthorized (status code 401) or Forbidden (status code 403) or Not Found (status code 404)

    • copyTestCaseWhileTestPlansCompare

      @RequestMapping(method=POST, value="/catalog/api/v1/testcases/compare/copy", produces="application/json", consumes="application/json") org.springframework.http.ResponseEntity<TestCaseCompareCopyResponseDto> copyTestCaseWhileTestPlansCompare(@Valid @RequestBody(required=false) @Valid CompareItemCopyRequestDto compareItemCopyRequestDto)
      POST /catalog/api/v1/testcases/compare/copy : copyTestCaseWhileTestPlansCompare
      Parameters:
      compareItemCopyRequestDto - (optional)
      Returns:
      OK (status code 200) or Unauthorized (status code 401) or Forbidden (status code 403) or Not Found (status code 404)

    • copyTestCases

      @RequestMapping(method=POST, value="/catalog/api/v1/testcases/copy", consumes="application/json") org.springframework.http.ResponseEntity<Void> copyTestCases(@Valid @RequestBody(required=false) @Valid CopyRequestDto copyRequestDto)
      POST /catalog/api/v1/testcases/copy : copyTestCases
      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)

    • copyTestCasesWithScenarios

      @RequestMapping(method=GET, value="/catalog/api/v1/testcases/testscenarios/copy", consumes="application/json") org.springframework.http.ResponseEntity<Void> copyTestCasesWithScenarios(@Valid @RequestBody(required=false) @Valid TestCasesCopyRequestDto testCasesCopyRequestDto)
      GET /catalog/api/v1/testcases/testscenarios/copy : copyTestCasesWithScenarios
      Parameters:
      testCasesCopyRequestDto - (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/testcases", produces="application/json", consumes="application/json") org.springframework.http.ResponseEntity<List<UUID>> create(@Valid @RequestBody(required=false) @Valid CaseCreationRequestDto caseCreationRequestDto)
      POST /catalog/api/v1/testcases : create
      Parameters:
      caseCreationRequestDto - (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/testcases", consumes="application/json") org.springframework.http.ResponseEntity<Void> delete(@Valid @RequestBody(required=false) @Valid Set<UUID> UUID)
      DELETE /catalog/api/v1/testcases : 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)

    • deleteLabelsFromTestCases

      @RequestMapping(method=DELETE, value="/catalog/api/v1/testcases/labels", consumes="application/json") org.springframework.http.ResponseEntity<Void> deleteLabelsFromTestCases(@Valid @RequestBody(required=false) @Valid LabelsRequestDto labelsRequestDto)
      DELETE /catalog/api/v1/testcases/labels : deleteLabelsFromTestCases
      Parameters:
      labelsRequestDto - (optional)
      Returns:
      OK (status code 200) or No Content (status code 204) or Unauthorized (status code 401) or Forbidden (status code 403)

    • deleteTestCaseComponents

      @RequestMapping(method=DELETE, value="/catalog/api/v1/testcases/components", produces="application/json", consumes="application/json") org.springframework.http.ResponseEntity<TestCaseComponentsDeleteResponseDto> deleteTestCaseComponents(@Valid @RequestBody(required=false) @Valid TestCaseComponentsDeleteRequestDto testCaseComponentsDeleteRequestDto)
      DELETE /catalog/api/v1/testcases/components : delete test case components
      Parameters:
      testCaseComponentsDeleteRequestDto - (optional)
      Returns:
      OK (status code 200) or Unauthorized (status code 401) or Forbidden (status code 403) or Not Found (status code 404)

    • getAll

      @RequestMapping(method=GET, value="/catalog/api/v1/testcases", produces="application/json") org.springframework.http.ResponseEntity<List<TestCaseDto>> getAll()
      GET /catalog/api/v1/testcases : 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/testcases/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/testcases/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)

    • getCaseLabels

      @RequestMapping(method=POST, value="/catalog/api/v1/testcases/labels/search", produces="application/json", consumes="application/json") org.springframework.http.ResponseEntity<List<TestCaseLabelResponseDto>> getCaseLabels(@Valid @RequestBody(required=false) @Valid Set<UUID> UUID)
      POST /catalog/api/v1/testcases/labels/search : getCaseLabels
      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)

    • getDataSetListTestCasesUsages

      @RequestMapping(method=GET, value="/catalog/api/v1/testcases/dataSetLists/{dslId}/usages", produces="application/json") org.springframework.http.ResponseEntity<PaginationResponseDto> getDataSetListTestCasesUsages(@PathVariable("dslId") UUID dslId, @NotNull @Valid @RequestParam(value="page",required=true) @NotNull @Valid Integer page, @NotNull @Valid @RequestParam(value="size",required=true) @NotNull @Valid Integer size)
      GET /catalog/api/v1/testcases/dataSetLists/{dslId}/usages : getDataSetListTestCasesUsages
      Parameters:
      dslId - data set list id (required)
      page - page number (required)
      size - size number (required)
      Returns:
      OK (status code 200) or Unauthorized (status code 401) or Forbidden (status code 403) or Not Found (status code 404)

    • getDataSetListTestCasesUsagesCount

      @RequestMapping(method=GET, value="/catalog/api/v1/testcases/dataSetLists/{dslId}/usages/count", produces="application/json") org.springframework.http.ResponseEntity<Integer> getDataSetListTestCasesUsagesCount(@PathVariable("dslId") UUID dslId)
      GET /catalog/api/v1/testcases/dataSetLists/{dslId}/usages/count : getDataSetListTestCasesUsagesCount
      Parameters:
      dslId - data set list id (required)
      Returns:
      OK (status code 200) or Unauthorized (status code 401) or Forbidden (status code 403) or Not Found (status code 404)

    • getDataSetTestCasesUsages

      @RequestMapping(method=GET, value="/catalog/api/v1/testcases/datasets/{dslId}/usages", produces="application/json") org.springframework.http.ResponseEntity<PaginationResponseDto> getDataSetTestCasesUsages(@PathVariable("dslId") UUID dslId, @NotNull @Valid @RequestParam(value="page",required=true) @NotNull @Valid Integer page, @NotNull @Valid @RequestParam(value="size",required=true) @NotNull @Valid Integer size)
      GET /catalog/api/v1/testcases/datasets/{dslId}/usages : getDataSetTestCasesUsages
      Parameters:
      dslId - data set list id (required)
      page - page number (required)
      size - size number (required)
      Returns:
      OK (status code 200) or Unauthorized (status code 401) or Forbidden (status code 403) or Not Found (status code 404)

    • getDataSetTestCasesUsagesCount

      @RequestMapping(method=GET, value="/catalog/api/v1/testcases/datasets/{dsId}/usages/count", produces="application/json") org.springframework.http.ResponseEntity<Integer> getDataSetTestCasesUsagesCount(@PathVariable("dsId") UUID dsId)
      GET /catalog/api/v1/testcases/datasets/{dsId}/usages/count : getDataSetTestCasesUsagesCount
      Parameters:
      dsId - data set id (required)
      Returns:
      OK (status code 200) or Unauthorized (status code 401) or Forbidden (status code 403) or Not Found (status code 404)

    • getDetailedCase

      @RequestMapping(method=GET, value="/catalog/api/v1/testcases/{uuid}/detailed", produces="application/json") org.springframework.http.ResponseEntity<TestCaseResponseDto> getDetailedCase(@PathVariable("uuid") UUID uuid)
      GET /catalog/api/v1/testcases/{uuid}/detailed : getDetailedCase
      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)

    • getDetailedCases

      @RequestMapping(method=POST, value="/catalog/api/v1/testcases/detailed", produces="application/json", consumes="application/json") org.springframework.http.ResponseEntity<List<TestCaseResponseDto>> getDetailedCases(@Valid @RequestBody(required=false) @Valid Set<UUID> UUID)
      POST /catalog/api/v1/testcases/detailed : getDetailedCases
      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)

    • getEnrichedCase

      @RequestMapping(method=GET, value="/catalog/api/v1/testcases/{uuid}/enriched", produces="application/json") org.springframework.http.ResponseEntity<EnrichedCaseDto> getEnrichedCase(@PathVariable("uuid") UUID uuid, @Valid @RequestParam(value="testscopeid",required=false) @Valid UUID testscopeid)
      GET /catalog/api/v1/testcases/{uuid}/enriched : getEnrichedCase
      Parameters:
      uuid - uuid (required)
      testscopeid - testscopeid (optional)
      Returns:
      OK (status code 200) or Unauthorized (status code 401) or Forbidden (status code 403) or Not Found (status code 404)

    • getEnrichedCases

      @RequestMapping(method=POST, value="/catalog/api/v1/testcases/enriched", produces="application/json", consumes="application/json") org.springframework.http.ResponseEntity<List<EnrichedCaseDto>> getEnrichedCases(@Valid @RequestParam(value="testscopeid",required=false) @Valid UUID testscopeid, @Valid @RequestBody(required=false) @Valid Set<UUID> UUID)
      POST /catalog/api/v1/testcases/enriched : getEnrichedCases
      Parameters:
      testscopeid - testscopeid (optional)
      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)

    • getScenarioIdByTestCaseId

      @RequestMapping(method=GET, value="/catalog/api/v1/testcases/{uuid}/testscenario-id", produces="application/json") org.springframework.http.ResponseEntity<UUID> getScenarioIdByTestCaseId(@PathVariable("uuid") UUID uuid)
      GET /catalog/api/v1/testcases/{uuid}/testscenario-id : getScenarioIdByTestCaseId
      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)

    • getTestCaseComponents

      @RequestMapping(method=POST, value="/catalog/api/v1/testcases/components/search", produces="application/json", consumes="application/json") org.springframework.http.ResponseEntity<List<JiraComponentDto>> getTestCaseComponents(@Valid @RequestBody(required=false) @Valid TestCaseComponentsSearchRequestDto testCaseComponentsSearchRequestDto)
      POST /catalog/api/v1/testcases/components/search : search test case components
      Parameters:
      testCaseComponentsSearchRequestDto - (optional)
      Returns:
      OK (status code 200) or Unauthorized (status code 401) or Forbidden (status code 403) or Not Found (status code 404)

    • getTestCaseWithLabelsByUuid

      @RequestMapping(method=GET, value="/catalog/api/v1/testcases/{uuid}", produces="application/json") org.springframework.http.ResponseEntity<TestCaseDto> getTestCaseWithLabelsByUuid(@PathVariable("uuid") UUID uuid)
      GET /catalog/api/v1/testcases/{uuid} : getTestCaseWithLabelsByUuid
      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)

    • getTestCasesByDsId

      @RequestMapping(method=POST, value="/catalog/api/v1/testcases/search/DS/{uuid}", produces="application/json") org.springframework.http.ResponseEntity<Integer> getTestCasesByDsId(@PathVariable("uuid") UUID uuid)
      POST /catalog/api/v1/testcases/search/DS/{uuid} : getTestCasesByDsId
      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)

    • getTestCasesByIds

      @RequestMapping(method=POST, value="/catalog/api/v1/testcases/search/by_ids", produces="application/json", consumes="application/json") org.springframework.http.ResponseEntity<List<TestCaseDto>> getTestCasesByIds(@Valid @RequestBody(required=false) @Valid CaseSearchRequestDto caseSearchRequestDto)
      POST /catalog/api/v1/testcases/search/by_ids : getTestCasesByIds
      Parameters:
      caseSearchRequestDto - (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)

    • getTestCasesByProjectUuid

      @RequestMapping(method=GET, value="/catalog/api/v1/testcases/project/{uuid}", produces="application/json") org.springframework.http.ResponseEntity<List<TestCaseResponseDto>> getTestCasesByProjectUuid(@PathVariable("uuid") UUID uuid)
      GET /catalog/api/v1/testcases/project/{uuid} : getTestCasesByProjectUuid
      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)

    • moveTestCases

      @RequestMapping(method=POST, value="/catalog/api/v1/testcases/move", consumes="application/json") org.springframework.http.ResponseEntity<Void> moveTestCases(@Valid @RequestBody(required=false) @Valid MoveRequestDto moveRequestDto)
      POST /catalog/api/v1/testcases/move : moveTestCases
      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)

    • patch

      @RequestMapping(method=PATCH, value="/catalog/api/v1/testcases/{uuid}", consumes="application/json") org.springframework.http.ResponseEntity<Void> patch(@PathVariable("uuid") UUID uuid, @Valid @RequestBody(required=false) @Valid CasePatchUpdateRequestDto casePatchUpdateRequestDto)
      PATCH /catalog/api/v1/testcases/{uuid} : patch
      Parameters:
      uuid - uuid (required)
      casePatchUpdateRequestDto - (optional)
      Returns:
      OK (status code 200) or No Content (status code 204) or Unauthorized (status code 401) or Forbidden (status code 403)

    • patchUpdate

      @Deprecated @RequestMapping(method=PUT, value="/catalog/api/v1/testcases/{uuid}/patch", consumes="application/json") org.springframework.http.ResponseEntity<Void> patchUpdate(@PathVariable("uuid") UUID uuid, @Valid @RequestBody(required=false) @Valid CasePatchUpdateRequestDto casePatchUpdateRequestDto)
      Deprecated.
      PUT /catalog/api/v1/testcases/{uuid}/patch : patchUpdate
      Parameters:
      uuid - uuid (required)
      casePatchUpdateRequestDto - (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)

    • replaceTestCasesDataset

      @RequestMapping(method=POST, value="/catalog/api/v1/testcases/dataset/replace", consumes="application/json") org.springframework.http.ResponseEntity<Void> replaceTestCasesDataset(@Valid @RequestBody(required=false) @Valid TestCasesDataSetReplaceRequestDto testCasesDataSetReplaceRequestDto)
      POST /catalog/api/v1/testcases/dataset/replace : replaceTestCasesDataset
      Parameters:
      testCasesDataSetReplaceRequestDto - (optional)
      Returns:
      OK (status code 200) or No Content (status code 204) or Unauthorized (status code 401) or Forbidden (status code 403) or Not Found (status code 404)

    • search

      @RequestMapping(method=POST, value="/catalog/api/v1/testcases/search", produces="application/json", consumes="application/json") org.springframework.http.ResponseEntity<TestCaseDto> search(@Valid @RequestBody(required=false) @Valid TestCaseSearchRequestDto testCaseSearchRequestDto)
      POST /catalog/api/v1/testcases/search : search test cases
      Parameters:
      testCaseSearchRequestDto - (optional)
      Returns:
      OK (status code 200) or Unauthorized (status code 401) or Forbidden (status code 403) or Not Found (status code 404)

    • searchEnrichedCases

      @RequestMapping(method=POST, value="/catalog/api/v1/testcases/enriched/search", produces="application/json", consumes="application/json") org.springframework.http.ResponseEntity<List<EnrichedCaseDto>> searchEnrichedCases(@Valid @RequestParam(value="testscopeid",required=false) @Valid UUID testscopeid, @Valid @RequestBody(required=false) @Valid CaseSearchRequestDto caseSearchRequestDto)
      POST /catalog/api/v1/testcases/enriched/search : searchEnrichedCases
      Parameters:
      testscopeid - testscopeid (optional)
      caseSearchRequestDto - (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)

    • setTestCaseComponents

      @RequestMapping(method=POST, value="/catalog/api/v1/testcases/components/set", consumes="application/json") org.springframework.http.ResponseEntity<Void> setTestCaseComponents(@Valid @RequestBody(required=false) @Valid TestCaseComponentsSetRequestDto testCaseComponentsSetRequestDto)
      POST /catalog/api/v1/testcases/components/set : set test case components
      Parameters:
      testCaseComponentsSetRequestDto - (optional)
      Returns:
      No Content (status code 204) or Unauthorized (status code 401) or Forbidden (status code 403) or Not Found (status code 404)

    • setTestCaseDatasets

      @RequestMapping(method=POST, value="/catalog/api/v1/testcases/datasets/set", consumes="application/json") org.springframework.http.ResponseEntity<Void> setTestCaseDatasets(@Valid @RequestBody(required=false) @Valid TestCaseDatasetsSetRequestDto testCaseDatasetsSetRequestDto)
      POST /catalog/api/v1/testcases/datasets/set : setTestCaseDatasets
      Parameters:
      testCaseDatasetsSetRequestDto - (optional)
      Returns:
      No Content (status code 204) or Unauthorized (status code 401) or Forbidden (status code 403) or Not Found (status code 404)

    • update

      @RequestMapping(method=PUT, value="/catalog/api/v1/testcases/{uuid}", consumes="application/json") org.springframework.http.ResponseEntity<Void> update(@PathVariable("uuid") UUID uuid, @Valid @RequestBody(required=false) @Valid CaseUpdateRequestDto caseUpdateRequestDto)
      PUT /catalog/api/v1/testcases/{uuid} : update
      Parameters:
      uuid - uuid (required)
      caseUpdateRequestDto - (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)

    • updateCaseStatuses

      @RequestMapping(method=POST, value="/catalog/api/v1/testcases/status-update", consumes="application/json") org.springframework.http.ResponseEntity<Void> updateCaseStatuses(@Valid @RequestBody(required=false) @Valid List<TestCaseLastStatusDto> testCaseLastStatusDto)
      POST /catalog/api/v1/testcases/status-update : updateCaseStatuses
      Parameters:
      testCaseLastStatusDto - (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)