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

Interface DataSetListControllerApi

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

  • Method Details

    • addLabel

      @RequestMapping(method=PUT, value="/dsl/{dataSetListId}/label", produces="application/json") org.springframework.http.ResponseEntity<LabelDto> addLabel(@PathVariable("dataSetListId") UUID dataSetListId, @NotNull @Valid @RequestParam(value="name",required=true) @NotNull @Valid String name, @Valid @RequestParam(value="modifiedWhen",required=false) @Valid Long modifiedWhen)
      PUT /dsl/{dataSetListId}/label : addLabel
      Parameters:
      dataSetListId - dataSetListId (required)
      name - name (required)
      modifiedWhen - modifiedWhen (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)

    • copy

      @RequestMapping(method=POST, value="/dsl/copy", produces="application/json", consumes="application/json") org.springframework.http.ResponseEntity<List<CopyDataSetListsResponseDto>> copy(@Valid @RequestBody(required=false) @Valid CopyDataSetListsRequestDto copyDataSetListsRequestDto)
      POST /dsl/copy : Copy DSL with name provided.
      Parameters:
      copyDataSetListsRequestDto - (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)

    • copyBulk

      @RequestMapping(method=POST, value="/dsl/ds/clone/bulk", produces="application/json", consumes="application/json") org.springframework.http.ResponseEntity<Map<String,PairDto>> copyBulk(@NotNull @Valid @RequestParam(value="name",required=true) @NotNull @Valid String name, @Valid @RequestBody(required=false) @Valid Map<String,Set<UUID>> requestBody)
      POST /dsl/ds/clone/bulk : Copy DSLs and DSs. Uses for cloning of test plan on Catalog
      Parameters:
      name - name (required)
      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)

    • copyByVaIdDataSetListId

      @RequestMapping(method=PUT, value="/dsl/va/{vaId}/dsl/{dataSetListId}/copy", produces="application/json") org.springframework.http.ResponseEntity<UUID> copyByVaIdDataSetListId(@PathVariable("dataSetListId") UUID dataSetListId, @PathVariable("vaId") UUID vaId, @NotNull @Valid @RequestParam(value="name",required=true) @NotNull @Valid String name, @Valid @RequestParam(value="type",required=false) @Valid Boolean type, @Valid @RequestParam(value="testPlan",required=false) @Valid UUID testPlan)
      PUT /dsl/va/{vaId}/dsl/{dataSetListId}/copy : Copy DSL with name provided.
      Parameters:
      dataSetListId - dataSetListId (required)
      vaId - vaId (required)
      name - name (required)
      type - type (optional)
      testPlan - testPlan (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="/dsl/va/{vaId}", produces="application/json") org.springframework.http.ResponseEntity<UUID> create(@PathVariable("vaId") UUID vaId, @NotNull @Valid @RequestParam(value="name",required=true) @NotNull @Valid String name, @Valid @RequestParam(value="testPlan",required=false) @Valid UUID testPlan)
      PUT /dsl/va/{vaId} : Creates new DSL with name provided.
      Parameters:
      vaId - vaId (required)
      name - name (required)
      testPlan - testPlan (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="/dsl/{dataSetListId}") org.springframework.http.ResponseEntity<Void> delete(@PathVariable("dataSetListId") UUID dataSetListId)
      DELETE /dsl/{dataSetListId} : Deletes selected DSL.
      Parameters:
      dataSetListId - dataSetListId (required)
      Returns:
      No Content (status code 204) or Unauthorized (status code 401) or Forbidden (status code 403)

    • deleteLabel

      @RequestMapping(method=DELETE, value="/dsl/{dataSetListId}/label/{labelId}", produces="application/json") org.springframework.http.ResponseEntity<Boolean> deleteLabel(@PathVariable("dataSetListId") UUID dataSetListId, @PathVariable("labelId") UUID labelId, @Valid @RequestParam(value="modifiedWhen",required=false) @Valid Long modifiedWhen)
      DELETE /dsl/{dataSetListId}/label/{labelId} : deleteLabel
      Parameters:
      dataSetListId - dataSetListId (required)
      labelId - labelId (required)
      modifiedWhen - modifiedWhen (optional)
      Returns:
      OK (status code 200) or No Content (status code 204) or Unauthorized (status code 401) or Forbidden (status code 403)

    • existsById

      @RequestMapping(method=GET, value="/dsl/{dataSetListId}/exists") org.springframework.http.ResponseEntity<Void> existsById(@PathVariable("dataSetListId") UUID dataSetListId)
      GET /dsl/{dataSetListId}/exists : Check if dsl exists.
      Parameters:
      dataSetListId - dataSetListId (required)
      Returns:
      OK (status code 200) or Unauthorized (status code 401) or Forbidden (status code 403) or Not Found (status code 404)

    • exportDataSetList

      @RequestMapping(method=POST, value="/dsl/{dataSetListId}/export/excel", produces="application/vnd.openxmlformats-officedocument.spreadsheetml.sheet") org.springframework.http.ResponseEntity<org.springframework.core.io.Resource> exportDataSetList(@PathVariable("dataSetListId") UUID dataSetListId)
      POST /dsl/{dataSetListId}/export/excel : Export dsl to file.
      Parameters:
      dataSetListId - dataSetListId (required)
      Returns:
      OK (status code 200) or Unauthorized (status code 401) or Forbidden (status code 403) or Not Found (status code 404)

    • getAffectedAttributes

      @RequestMapping(method=GET, value="/dsl/{dataSetListId}/getAffected", produces="application/json") org.springframework.http.ResponseEntity<List<TableResponseDto>> getAffectedAttributes(@PathVariable("dataSetListId") UUID dataSetListId)
      GET /dsl/{dataSetListId}/getAffected : Get affected attribute by deleting dsl( data set storage).
      Parameters:
      dataSetListId - dataSetListId (required)
      Returns:
      OK (status code 200) or Unauthorized (status code 401) or Forbidden (status code 403) or Not Found (status code 404)

    • getAffectedAttributesCount

      @RequestMapping(method=GET, value="/dsl/{dataSetListId}/getAffectedCount", produces="application/json") org.springframework.http.ResponseEntity<BigDecimal> getAffectedAttributesCount(@PathVariable("dataSetListId") UUID dataSetListId)
      GET /dsl/{dataSetListId}/getAffectedCount : Get affected attribute count by dsl.
      Parameters:
      dataSetListId - dataSetListId (required)
      Returns:
      OK (status code 200) or Unauthorized (status code 401) or Forbidden (status code 403) or Not Found (status code 404)

    • getAffectedDataSetLists

      @RequestMapping(method=GET, value="/dsl/{dataSetListId}/getAffectedDSL", produces="application/json") org.springframework.http.ResponseEntity<Void> getAffectedDataSetLists(@PathVariable("dataSetListId") UUID dataSetListId, @Valid @RequestParam(value="limit",required=false) @Valid Integer limit, @Valid @RequestParam(value="offset",required=false) @Valid Integer offset)
      GET /dsl/{dataSetListId}/getAffectedDSL : Get affected dsl by deleting dsl( data set storage).
      Parameters:
      dataSetListId - dataSetListId (required)
      limit - limit (optional)
      offset - offset (optional)
      Returns:
      OK (status code 200) or Partial Content (status code 206) or Unauthorized (status code 401) or Forbidden (status code 403) or Not Found (status code 404)

    • getCyclesCheck

      @RequestMapping(method=GET, value="/dsl/cyclesCheck", produces="application/json") org.springframework.http.ResponseEntity<CyclesCheckResultDto> getCyclesCheck()
      GET /dsl/cyclesCheck : Get affected attribute by deleting dsl( data set storage).
      Returns:
      OK (status code 200) or Unauthorized (status code 401) or Forbidden (status code 403) or Not Found (status code 404)

    • getDataSetInfoByDataSetListIdAndId

      @RequestMapping(method=GET, value="/dsl/{dataSetListId}/ds/{ds}", produces="application/json") org.springframework.http.ResponseEntity<Object> getDataSetInfoByDataSetListIdAndId(@PathVariable("dataSetListId") UUID dataSetListId, @PathVariable("ds") UUID ds)
      GET /dsl/{dataSetListId}/ds/{ds} : Returns information about the selected DS under DSL.
      Parameters:
      dataSetListId - dataSetListId (required)
      ds - ds (required)
      Returns:
      OK (status code 200) or Unauthorized (status code 401) or Forbidden (status code 403) or Not Found (status code 404)

    • getDataSetListFullInfo

      @RequestMapping(method=GET, value="/dsl/{dataSetListId}/full", produces="application/json") org.springframework.http.ResponseEntity<List<DataSetDto>> getDataSetListFullInfo(@PathVariable("dataSetListId") UUID dataSetListId)
      GET /dsl/{dataSetListId}/full : Returns datasets full information of the selected DSL.
      Parameters:
      dataSetListId - dataSetListId (required)
      Returns:
      OK (status code 200) or Unauthorized (status code 401) or Forbidden (status code 403) or Not Found (status code 404)

    • getDataSetListInfo

      @RequestMapping(method=GET, value="/dsl/{dataSetListId}", produces="application/json") org.springframework.http.ResponseEntity<Object> getDataSetListInfo(@PathVariable("dataSetListId") UUID dataSetListId, @Valid @RequestParam(value="filterDs",required=false) @Valid String filterDs, @Valid @RequestParam(value="filterAttr",required=false) @Valid String filterAttr, @Valid @RequestParam(value="flat",required=false) @Valid String flat, @Valid @RequestParam(value="new",required=false) @Valid String _new, @Valid @RequestParam(value="evaluate",required=false) @Valid String evaluate)
      GET /dsl/{dataSetListId} : Returns information about the selected DSL.
      Parameters:
      dataSetListId - dataSetListId (required)
      filterDs - filterDs (optional)
      filterAttr - filterAttr (optional)
      flat - flat (optional)
      _new - new (optional)
      evaluate - evaluate (optional)
      Returns:
      OK (status code 200) or Unauthorized (status code 401) or Forbidden (status code 403) or Not Found (status code 404)

    • getDataSetListInfoById

      @RequestMapping(method=POST, value="/dsl/{dataSetListId}/filters", produces="application/json", consumes="application/json") org.springframework.http.ResponseEntity<Object> getDataSetListInfoById(@PathVariable("dataSetListId") UUID dataSetListId, @Valid @RequestParam(value="evaluate",required=false) @Valid String evaluate, @Valid @RequestParam(value="startIndex",required=false) @Valid Integer startIndex, @Valid @RequestParam(value="endIndex",required=false) @Valid Integer endIndex, @Valid @RequestParam(value="sort",required=false) @Valid String sort, @Valid @RequestParam(value="expandAll",required=false) @Valid Boolean expandAll, @Valid @RequestBody(required=false) @Valid DataSetsAndAttributesFilterPairDto dataSetsAndAttributesFilterPairDto)
      POST /dsl/{dataSetListId}/filters : Returns information about the selected DSL.
      Parameters:
      dataSetListId - dataSetListId (required)
      evaluate - evaluate (optional)
      startIndex - startIndex (optional)
      endIndex - endIndex (optional)
      sort - sort (optional)
      expandAll - Specifies whether to load the entire tree of referenced datasets. Default - true (optional)
      dataSetsAndAttributesFilterPairDto - (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)

    • getDataSetLists

      @RequestMapping(method=GET, value="/dsl", produces="application/json") org.springframework.http.ResponseEntity<List<DataSetListCreatedModifiedViewDto>> getDataSetLists()
      GET /dsl : Returns all dataSetLists.
      Returns:
      OK (status code 200) or Unauthorized (status code 401) or Forbidden (status code 403) or Not Found (status code 404)

    • getDataSetListsByVaId

      @RequestMapping(method=GET, value="/dsl/va/{vaId}", produces="application/json") org.springframework.http.ResponseEntity<List<DataSetListCreatedModifiedViewDto>> getDataSetListsByVaId(@PathVariable("vaId") UUID vaId, @Valid @RequestParam(value="label",required=false) @Valid String label)
      GET /dsl/va/{vaId} : Returns all dataSetLists for selected visibility area.
      Parameters:
      vaId - vaId (required)
      label - label (optional)
      Returns:
      OK (status code 200) or Unauthorized (status code 401) or Forbidden (status code 403) or Not Found (status code 404)

    • getDataSets

      @RequestMapping(method=GET, value="/dsl/{dataSetListId}/ds", produces="application/json") org.springframework.http.ResponseEntity<List<DataSetDto>> getDataSets(@PathVariable("dataSetListId") UUID dataSetListId, @Valid @RequestParam(value="skipEvaluate",required=false) @Valid String skipEvaluate, @Valid @RequestParam(value="label",required=false) @Valid String label)
      GET /dsl/{dataSetListId}/ds : Returns datasets id/name information of the selected DSL.
      Parameters:
      dataSetListId - dataSetListId (required)
      skipEvaluate - skipEvaluate (optional)
      label - label (optional)
      Returns:
      OK (status code 200) or Unauthorized (status code 401) or Forbidden (status code 403) or Not Found (status code 404)

    • getDataSetsWithNameAndDataSetList

      @RequestMapping(method=POST, value="/dsl/ds/all", produces="application/json", consumes="application/json") org.springframework.http.ResponseEntity<List<DatasetResponseDto>> getDataSetsWithNameAndDataSetList(@Valid @RequestBody(required=false) @Valid List<UUID> UUID)
      POST /dsl/ds/all : getDataSetsWithNameAndDataSetList
      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)

    • getDependencies

      @RequestMapping(method=POST, value="/dsl/dependencies", produces="application/json", consumes="application/json") org.springframework.http.ResponseEntity<List<DataSetListDependencyNodeDto>> getDependencies(@Valid @RequestBody(required=false) @Valid List<UUID> UUID)
      POST /dsl/dependencies : Get dataset lists dependencies trees
      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)

    • getDependenciesRecursive

      @RequestMapping(method=POST, value="/dsl/dependenciesRecursive", produces="application/json", consumes="application/json") org.springframework.http.ResponseEntity<List<DataSetListDependencyNodeDto>> getDependenciesRecursive(@Valid @RequestBody(required=false) @Valid List<UUID> UUID)
      POST /dsl/dependenciesRecursive : Get dataset lists dependencies trees
      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)

    • getLabels

      @RequestMapping(method=GET, value="/dsl/{dataSetListId}/label", produces="application/json") org.springframework.http.ResponseEntity<List<LabelDto>> getLabels(@PathVariable("dataSetListId") UUID dataSetListId)
      GET /dsl/{dataSetListId}/label : getLabels
      Parameters:
      dataSetListId - dataSetListId (required)
      Returns:
      OK (status code 200) or Unauthorized (status code 401) or Forbidden (status code 403) or Not Found (status code 404)

    • getModifiedWhen

      @RequestMapping(method=GET, value="/dsl/{dataSetListId}/modifiedWhen", produces="application/json") org.springframework.http.ResponseEntity<OffsetDateTime> getModifiedWhen(@PathVariable("dataSetListId") UUID dataSetListId)
      GET /dsl/{dataSetListId}/modifiedWhen : Get dsl modifiedWhen.
      Parameters:
      dataSetListId - dataSetListId (required)
      Returns:
      OK (status code 200) or Unauthorized (status code 401) or Forbidden (status code 403) or Not Found (status code 404)

    • importDataSetList

      @RequestMapping(method=POST, value="/dsl/{dataSetListId}/import/excel", produces="application/json") org.springframework.http.ResponseEntity<DatasetListImportResponseDto> importDataSetList(@PathVariable("dataSetListId") UUID dataSetListId, @NotNull @Valid @RequestParam(value="projectId",required=true) @NotNull @Valid UUID projectId, @Valid @RequestParam(value="versioning",required=false) @Valid Boolean versioning)
      POST /dsl/{dataSetListId}/import/excel : Import dsl from excel file.
      Parameters:
      dataSetListId - dataSetListId (required)
      projectId - projectId (required)
      versioning - versioning (optional)
      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="/dsl/{dataSetListId}", produces="application/json") org.springframework.http.ResponseEntity<Boolean> rename(@PathVariable("dataSetListId") UUID dataSetListId, @Valid @RequestParam(value="name",required=false) @Valid String name, @Valid @RequestParam(value="testPlan",required=false) @Valid UUID testPlan, @Valid @RequestParam(value="clearTestPlan",required=false) @Valid String clearTestPlan, @Valid @RequestParam(value="modifiedWhen",required=false) @Valid Long modifiedWhen)
      POST /dsl/{dataSetListId} : Renames selected DSL.
      Parameters:
      dataSetListId - dataSetListId (required)
      name - name (optional)
      testPlan - testPlan (optional)
      clearTestPlan - clearTestPlan (optional)
      modifiedWhen - modifiedWhen (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)