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

Interface LabelControllerApi

All Known Subinterfaces:

CatalogueLabelFeignClient

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

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<LabelDto>	create(@Valid LabelDto labelDto)	POST /catalog/api/v1/labels : create
org.springframework.http.ResponseEntity<Void>	delete(UUID uuid)	DELETE /catalog/api/v1/labels/{uuid} : delete
org.springframework.http.ResponseEntity<List<TestCaseShortResponseDto>>	findTestCaseUsages(UUID uuid, @Valid TestPlanIdRequestDto testPlanIdRequestDto)	POST /catalog/api/v1/labels/{uuid}/findTestCaseUsages : findTestCaseUsages
org.springframework.http.ResponseEntity<List<TestPlanShortResponseDto>>	findTestPlanUsages(UUID uuid)	POST /catalog/api/v1/labels/{uuid}/findTestPlanUsages : findTestPlanUsages
org.springframework.http.ResponseEntity<List<LabelUsageResponseDto>>	findUsageCounts(UUID uuid)	POST /catalog/api/v1/labels/{uuid}/findUsageCounts : findUsageCounts
org.springframework.http.ResponseEntity<List<LabelDto>>	getAll(@NotNull @Valid UUID projectId, @Valid UUID testPlanId)	GET /catalog/api/v1/labels : getAll
org.springframework.http.ResponseEntity<List<LabelDto>>	getLabelsByIds(@NotNull @Valid Set<UUID> labelIds)	GET /catalog/api/v1/labels/search : getLabelsByIds
org.springframework.http.ResponseEntity<List<LabelWithRefsResponseDto>>	search(@NotNull @Valid UUID projectId, @Valid List<String> refs, @Valid Integer page, @Valid Integer size, @Valid LabelFilteringRequestBodyDto labelFilteringRequestBodyDto)	POST /catalog/api/v1/labels/search : search
org.springframework.http.ResponseEntity<Void>	unassign(UUID uuid, @Valid TestPlanAndCaseIdsRequestDto testPlanAndCaseIdsRequestDto)	POST /catalog/api/v1/labels/{uuid}/unassign : unassign
org.springframework.http.ResponseEntity<LabelDto>	update(UUID uuid, @Valid LabelDto labelDto)	PUT /catalog/api/v1/labels/{uuid} : update

Method Details

create

@RequestMapping(method=POST,
                value="/catalog/api/v1/labels",
                produces="application/json",
                consumes="application/json")
org.springframework.http.ResponseEntity<LabelDto> create(@Valid @RequestBody(required=false)
 @Valid LabelDto labelDto)

POST /catalog/api/v1/labels : create

Parameters:

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

DELETE /catalog/api/v1/labels/{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)

findTestCaseUsages

@RequestMapping(method=POST,
                value="/catalog/api/v1/labels/{uuid}/findTestCaseUsages",
                produces="application/json",
                consumes="application/json")
org.springframework.http.ResponseEntity<List<TestCaseShortResponseDto>> findTestCaseUsages(@PathVariable("uuid")
 UUID uuid,
 @Valid @RequestBody(required=false)
 @Valid TestPlanIdRequestDto testPlanIdRequestDto)

POST /catalog/api/v1/labels/{uuid}/findTestCaseUsages : findTestCaseUsages

Parameters:

uuid - uuid (required)

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

findTestPlanUsages

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

POST /catalog/api/v1/labels/{uuid}/findTestPlanUsages : findTestPlanUsages

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)

findUsageCounts

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

POST /catalog/api/v1/labels/{uuid}/findUsageCounts : findUsageCounts

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/labels",
                produces="application/json")
org.springframework.http.ResponseEntity<List<LabelDto>> getAll(@NotNull @Valid @RequestParam(value="projectId",required=true)
 @NotNull @Valid UUID projectId,
 @Valid @RequestParam(value="testPlanId",required=false)
 @Valid UUID testPlanId)

GET /catalog/api/v1/labels : getAll

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)

getLabelsByIds

@RequestMapping(method=GET,
                value="/catalog/api/v1/labels/search",
                produces="application/json")
org.springframework.http.ResponseEntity<List<LabelDto>> getLabelsByIds(@NotNull @Valid @RequestParam(value="labelIds",required=true)
 @NotNull @Valid Set<UUID> labelIds)

GET /catalog/api/v1/labels/search : getLabelsByIds

Parameters:

labelIds - labelIds (required)

Returns:

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

search

@RequestMapping(method=POST,
                value="/catalog/api/v1/labels/search",
                produces="application/json",
                consumes="application/json")
org.springframework.http.ResponseEntity<List<LabelWithRefsResponseDto>> search(@NotNull @Valid @RequestParam(value="projectId",required=true)
 @NotNull @Valid UUID projectId,
 @Valid @RequestParam(value="refs",required=false)
 @Valid List<String> refs,
 @Valid @RequestParam(value="page",required=false)
 @Valid Integer page,
 @Valid @RequestParam(value="size",required=false)
 @Valid Integer size,
 @Valid @RequestBody(required=false)
 @Valid LabelFilteringRequestBodyDto labelFilteringRequestBodyDto)

POST /catalog/api/v1/labels/search : search

Parameters:

projectId - projectId (required)

refs - refs (optional)

page - page number (optional)

size - size number (optional)

labelFilteringRequestBodyDto - (optional)

Returns:

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

unassign

@RequestMapping(method=POST,
                value="/catalog/api/v1/labels/{uuid}/unassign",
                consumes="application/json")
org.springframework.http.ResponseEntity<Void> unassign(@PathVariable("uuid")
 UUID uuid,
 @Valid @RequestBody(required=false)
 @Valid TestPlanAndCaseIdsRequestDto testPlanAndCaseIdsRequestDto)

POST /catalog/api/v1/labels/{uuid}/unassign : unassign

Parameters:

uuid - uuid (required)

testPlanAndCaseIdsRequestDto - (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/labels/{uuid}",
                produces="application/json",
                consumes="application/json")
org.springframework.http.ResponseEntity<LabelDto> update(@PathVariable("uuid")
 UUID uuid,
 @Valid @RequestBody(required=false)
 @Valid LabelDto labelDto)

PUT /catalog/api/v1/labels/{uuid} : update

Parameters:

uuid - uuid (required)

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