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

Interface ProjectControllerApi

All Known Subinterfaces:
CatalogueProjectFeignClient
@Generated(value="org.openapitools.codegen.languages.SpringCodegen", date="2025-06-27T09:48:25.464932011Z[Etc/UTC]") @Validated public interface ProjectControllerApi

  • Method Details

    • checkFlags

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

    • create

      @RequestMapping(method=POST, value="/catalog/api/v1/projects/create", produces="application/json", consumes="application/json") org.springframework.http.ResponseEntity<UUID> create(@Valid @RequestBody(required=false) @Valid ProjectDto projectDto)
      POST /catalog/api/v1/projects/create : create
      Parameters:
      projectDto - (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)

    • deleteUserFromProject

      @RequestMapping(method=DELETE, value="/catalog/api/v1/projects/{uuid}/users/{usersuuid}", produces="application/json") org.springframework.http.ResponseEntity<ProjectDto> deleteUserFromProject(@PathVariable("uuid") UUID uuid, @PathVariable("usersuuid") UUID usersuuid)
      DELETE /catalog/api/v1/projects/{uuid}/users/{usersuuid} : deleteUserFromProject
      Parameters:
      uuid - uuid (required)
      usersuuid - usersuuid (required)
      Returns:
      OK (status code 200) or No Content (status code 204) or Unauthorized (status code 401) or Forbidden (status code 403)

    • downloadFile

      @RequestMapping(method=GET, value="/catalog/api/v1/projects/downloadFile/{fileId}", produces="application/octet-stream") org.springframework.http.ResponseEntity<org.springframework.core.io.Resource> downloadFile(@PathVariable("fileId") String fileId)
      GET /catalog/api/v1/projects/downloadFile/{fileId} : downloadFile
      Parameters:
      fileId - fileId (required)
      Returns:
      OK (status code 200) or Unauthorized (status code 401) or Forbidden (status code 403) or Not Found (status code 404)

    • getActionsByProjectId

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

    • getActionsByProjectUuidGroupedByActionType

      @RequestMapping(method=GET, value="/catalog/api/v1/projects/{uuid}/actions/group-by-type-action", produces="application/json") org.springframework.http.ResponseEntity<List<ActionGroupByTypeCompoundEntryDto>> getActionsByProjectUuidGroupedByActionType(@PathVariable("uuid") UUID uuid)
      GET /catalog/api/v1/projects/{uuid}/actions/group-by-type-action : getActionsByProjectUuidGroupedByActionType
      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)

    • getAll

      @RequestMapping(method=GET, value="/catalog/api/v1/projects", produces="application/json") org.springframework.http.ResponseEntity<Set<ProjectDto>> getAll()
      GET /catalog/api/v1/projects : 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/projects/{uuid}/compounds/compound_from_ts", produces="application/json") org.springframework.http.ResponseEntity<List<AbstractTestScenarioDto>> getAllCompoundsAndScenarioCompounds(@PathVariable("uuid") UUID uuid)
      GET /catalog/api/v1/projects/{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)

    • getAllCompoundsByProject

      @RequestMapping(method=GET, value="/catalog/api/v1/projects/{uuid}/compounds", produces="application/json") org.springframework.http.ResponseEntity<List<CompoundDto>> getAllCompoundsByProject(@PathVariable("uuid") UUID uuid)
      GET /catalog/api/v1/projects/{uuid}/compounds : getAllCompoundsByProject
      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/projects/{uuid}/compound_from_ts", produces="application/json") org.springframework.http.ResponseEntity<List<TestScenarioDto>> getAllCompoundsMadeFromTestScenario(@PathVariable("uuid") UUID uuid)
      GET /catalog/api/v1/projects/{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)

    • getAllGroups

      @RequestMapping(method=GET, value="/catalog/api/v1/projects/{uuid}/users/groups", produces="application/json") org.springframework.http.ResponseEntity<List<UserGroupDto>> getAllGroups(@PathVariable("uuid") String uuid)
      GET /catalog/api/v1/projects/{uuid}/users/groups : getAllGroups
      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)

    • getAllQaDslLibrariesInProject

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

    • getAllShortProjects

      @RequestMapping(method=GET, value="/catalog/api/v1/projects/short", produces="application/json") org.springframework.http.ResponseEntity<List<ProjectDto>> getAllShortProjects()
      GET /catalog/api/v1/projects/short : getAllShortProjects
      Returns:
      OK (status code 200) or Unauthorized (status code 401) or Forbidden (status code 403) or Not Found (status code 404)

    • getAllUsersByProject

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

    • getCertificate

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

    • getItfUrl

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

    • getNotMappedTestPlansByProjectId

      @RequestMapping(method=GET, value="/catalog/api/v1/projects/{uuid}/testplans/qa-dsl-not-mapped", produces="application/json") org.springframework.http.ResponseEntity<List<TestPlanDto>> getNotMappedTestPlansByProjectId(@PathVariable("uuid") UUID uuid)
      GET /catalog/api/v1/projects/{uuid}/testplans/qa-dsl-not-mapped : getNotMappedTestPlansByProjectId
      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)

    • getProjectById

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

    • getProjectNumberOfThresholdByProjectId

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

    • getProjectTestCaseLabels

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

    • getProjectsUsersById

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

    • getShortCasesByProjectId

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

    • getShortScopesByProjectId

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

    • getTestCaseGroupNamesByProjectId

      @RequestMapping(method=GET, value="/catalog/api/v1/projects/{uuid}/testcasegroups/short", produces="application/json") org.springframework.http.ResponseEntity<List<TestCaseGroupDto>> getTestCaseGroupNamesByProjectId(@PathVariable("uuid") UUID uuid, @NotNull @Valid @RequestParam(value="testPlanId",required=true) @NotNull @Valid UUID testPlanId)
      GET /catalog/api/v1/projects/{uuid}/testcasegroups/short : getTestCaseGroupNamesByProjectId
      Parameters:
      uuid - uuid (required)
      testPlanId - testPlanId (required)
      Returns:
      OK (status code 200) or Unauthorized (status code 401) or Forbidden (status code 403) or Not Found (status code 404)

    • getTestCaseGroupsByProjectId

      @RequestMapping(method=GET, value="/catalog/api/v1/projects/testcasegroups", produces="application/json") org.springframework.http.ResponseEntity<List<TestCaseGroupDto>> getTestCaseGroupsByProjectId(@Valid @RequestParam(value="projectId",required=false) @Valid UUID projectId)
      GET /catalog/api/v1/projects/testcasegroups : getTestCaseGroupsByProjectId
      Parameters:
      projectId - projectId (optional)
      Returns:
      OK (status code 200) or Unauthorized (status code 401) or Forbidden (status code 403) or Not Found (status code 404)

    • getTestPlansByProjectId

      @RequestMapping(method=GET, value="/catalog/api/v1/projects/{uuid}/testplans", produces="application/json") org.springframework.http.ResponseEntity<List<TestPlanDto>> getTestPlansByProjectId(@PathVariable("uuid") UUID uuid, @Valid @RequestParam(value="without-qa-dsl",required=false) @Valid String withoutQaDsl)
      GET /catalog/api/v1/projects/{uuid}/testplans : getTestPlansByProjectId
      Parameters:
      uuid - uuid (required)
      withoutQaDsl - without-qa-dsl (optional)
      Returns:
      OK (status code 200) or Unauthorized (status code 401) or Forbidden (status code 403) or Not Found (status code 404)

    • getTestScenariosByProjectId

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

    • getTestScopeByProjectId

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

    • update

      @RequestMapping(method=PUT, value="/catalog/api/v1/projects/save", produces="application/json", consumes="application/json") org.springframework.http.ResponseEntity<UUID> update(@Valid @RequestBody(required=false) @Valid ProjectDto projectDto)
      PUT /catalog/api/v1/projects/save : update
      Parameters:
      projectDto - (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)

    • updateActions

      @RequestMapping(method=POST, value="/catalog/api/v1/projects/{uuid}/updateActions") org.springframework.http.ResponseEntity<Void> updateActions(@PathVariable("uuid") UUID uuid)
      POST /catalog/api/v1/projects/{uuid}/updateActions : updateActions
      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)

    • updateProjectUsers

      @RequestMapping(method=PUT, value="/catalog/api/v1/projects/update/users", produces="application/json", consumes="application/json") org.springframework.http.ResponseEntity<ProjectDto> updateProjectUsers(@NotNull @Valid @RequestParam(value="type",required=true) @NotNull @Valid String type, @Valid @RequestBody(required=false) @Valid ProjectDto projectDto)
      PUT /catalog/api/v1/projects/update/users : updateProjectUsers
      Parameters:
      type - type (required)
      projectDto - (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)