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

Interface LabelTemplateControllerApi

All Known Subinterfaces:

CatalogueLabelTemplateFeignClient

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

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<UUID>	create(@Valid LabelTemplateDto labelTemplateDto)	POST /catalog/api/v1/label-templates : create
org.springframework.http.ResponseEntity<Void>	delete(UUID id)	DELETE /catalog/api/v1/label-templates/{id} : delete
org.springframework.http.ResponseEntity<LabelTemplateDto>	get(UUID id)	GET /catalog/api/v1/label-templates/{id} : get
org.springframework.http.ResponseEntity<List<LabelTemplateDto>>	getAll(@NotNull @Valid UUID projectId)	GET /catalog/api/v1/label-templates : getAll
org.springframework.http.ResponseEntity<List<PaginationResponseDto>>	search(@NotNull @Valid UUID projectId, @NotNull @Valid Integer page, @NotNull @Valid Integer size, @Valid LabelTemplateFilteringRequestBodyDto labelTemplateFilteringRequestBodyDto)	POST /catalog/api/v1/label-templates/search : search
org.springframework.http.ResponseEntity<Void>	update(UUID id, @Valid LabelTemplateDto labelTemplateDto)	PUT /catalog/api/v1/label-templates/{id} : update

Method Details

create

@RequestMapping(method=POST,
                value="/catalog/api/v1/label-templates",
                produces="application/json",
                consumes="application/json")
org.springframework.http.ResponseEntity<UUID> create(@Valid @RequestBody(required=false)
 @Valid LabelTemplateDto labelTemplateDto)

POST /catalog/api/v1/label-templates : create

Parameters:

labelTemplateDto - (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/label-templates/{id}")
org.springframework.http.ResponseEntity<Void> delete(@PathVariable("id")
 UUID id)

DELETE /catalog/api/v1/label-templates/{id} : delete

Parameters:

id - id (required)

Returns:

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

get

@RequestMapping(method=GET,
                value="/catalog/api/v1/label-templates/{id}",
                produces="application/json")
org.springframework.http.ResponseEntity<LabelTemplateDto> get(@PathVariable("id")
 UUID id)

GET /catalog/api/v1/label-templates/{id} : get

Parameters:

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

GET /catalog/api/v1/label-templates : getAll

Parameters:

projectId - projectId (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/label-templates/search",
                produces="application/json",
                consumes="application/json")
org.springframework.http.ResponseEntity<List<PaginationResponseDto>> search(@NotNull @Valid @RequestParam(value="projectId",required=true)
 @NotNull @Valid UUID projectId,
 @NotNull @Valid @RequestParam(value="page",required=true)
 @NotNull @Valid Integer page,
 @NotNull @Valid @RequestParam(value="size",required=true)
 @NotNull @Valid Integer size,
 @Valid @RequestBody(required=false)
 @Valid LabelTemplateFilteringRequestBodyDto labelTemplateFilteringRequestBodyDto)

POST /catalog/api/v1/label-templates/search : search

Parameters:

projectId - projectId (required)

page - page number (required)

size - size number (required)

labelTemplateFilteringRequestBodyDto - (optional)

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/label-templates/{id}",
                consumes="application/json")
org.springframework.http.ResponseEntity<Void> update(@PathVariable("id")
 UUID id,
 @Valid @RequestBody(required=false)
 @Valid LabelTemplateDto labelTemplateDto)

PUT /catalog/api/v1/label-templates/{id} : update

Parameters:

id - id (required)

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