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

Interface AttributeControllerApi

@Generated(value="org.openapitools.codegen.languages.SpringCodegen",
           date="2025-09-03T07:08:32.832733903Z[Etc/UTC]")
@Validated
public interface AttributeControllerApi

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<Void>	bulkDeleteListValues(UUID attributeId, @NotNull @Valid UUID listValues, @Valid UUID dataSetListId, @Valid Long modifiedWhen)	DELETE /attribute/{attributeId}/bulk : Bulk delete list values by id.
org.springframework.http.ResponseEntity<AttributeCreateResponseDto>	create(UUID dataSetListId, @NotNull @Valid String name, @NotNull @Valid Integer ordering, @NotNull @Valid AttributeTypeDto type, @Valid UUID typeDataSetListId, @Valid Long modifiedWhen, @Valid List<String> requestBody)	PUT /attribute/dsl/{dataSetListId} : Creates new attribute with provided name and order.
org.springframework.http.ResponseEntity<ListValueDto>	createListValue(UUID attributeId, @NotNull @Valid String value, @Valid UUID dataSetListId, @Valid Long modifiedWhen)	PUT /attribute/{attributeId}/listValues : Creates new list value for provided attribute.
org.springframework.http.ResponseEntity<List<UUID>>	createListValues(UUID attributeId, @Valid UUID dataSetListId, @Valid Long modifiedWhen, @Valid List<String> requestBody)	POST /attribute/{attributeId}/listValues : Creates new list values for provided attribute by text.
org.springframework.http.ResponseEntity<Boolean>	delete(UUID attributeId, @Valid UUID dataSetListId, @Valid Long modifiedWhen)	DELETE /attribute/{attributeId} : Deletes selected attribute.
org.springframework.http.ResponseEntity<Void>	deleteAllByDsl(UUID dataSetListId, @Valid Long modifiedWhen)	DELETE /attribute/dsl/{dataSetListId}/all : Deletes attributes from the selected dataSetsList.
org.springframework.http.ResponseEntity<Void>	deleteListValue(UUID attributeId, UUID listValueId, @Valid UUID dataSetListId, @Valid Long modifiedWhen)	DELETE /attribute/{attributeId}/listValues/{listValueId} : Delete list value by id.
org.springframework.http.ResponseEntity<AttributeDto>	get(UUID attributeId)	GET /attribute/{attributeId} : Returns attribute.
org.springframework.http.ResponseEntity<List<AttributeDto>>	getAttributes(UUID dataSetListId)	GET /attribute/dsl/{dataSetListId} : Returns all attributes by dataSetList id.
org.springframework.http.ResponseEntity<Object>	getAttributesInItfFormat(UUID dataSetListId)	GET /attribute/dsl/{dataSetListId}/itf : Returns all attributes by dataSetList id in itf format: [attr1.attr2, attr1].
org.springframework.http.ResponseEntity<Object>	getOptions(UUID attributeId)	GET /attribute/{attributeId}/options : getOptions
org.springframework.http.ResponseEntity<List<List>>	getParametersValuesAndDataSetIdsForAttributeValuesSorting(UUID dataSetListId, @NotNull @Valid UUID targetAttrId, @Valid Map<String,Set<UUID>> requestBody)	POST /attribute/{dataSetListId}/existedValues : Sort Attribute values.
org.springframework.http.ResponseEntity<Boolean>	rename(UUID attributeId, @NotNull @Valid String name, @Valid UUID dataSetListId, @Valid Long modifiedWhen)	POST /attribute/{attributeId} : Renames selected attribute.
org.springframework.http.ResponseEntity<Void>	setPosition(UUID attributeId, @Valid Integer body)	POST /attribute/{attributeId}/position : Creates new list values for provided attribute by text.
org.springframework.http.ResponseEntity<Boolean>	updateDslReference(UUID attributeId, @Valid UUID value)	POST /attribute/{attributeId}/dataSetListReference : Update DSL reference.
org.springframework.http.ResponseEntity<Void>	updateOrdering(@Valid List<PairOfUUidAndIntDto> pairOfUUidAndIntDto)	PUT /attribute/updateOrdering : updateOrdering

Method Details

bulkDeleteListValues

@RequestMapping(method=DELETE,
                value="/attribute/{attributeId}/bulk")
org.springframework.http.ResponseEntity<Void> bulkDeleteListValues(@PathVariable("attributeId")
 UUID attributeId,
 @NotNull @Valid @RequestParam(value="listValues",required=true)
 @NotNull @Valid UUID listValues,
 @Valid @RequestParam(value="dataSetListId",required=false)
 @Valid UUID dataSetListId,
 @Valid @RequestParam(value="modifiedWhen",required=false)
 @Valid Long modifiedWhen)

DELETE /attribute/{attributeId}/bulk : Bulk delete list values by id.

Parameters:

attributeId - attributeId (required)

listValues - listValues (required)

dataSetListId - dataSetListId (optional)

modifiedWhen - modifiedWhen (optional)

Returns:

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

create

@RequestMapping(method=PUT,
                value="/attribute/dsl/{dataSetListId}",
                produces="application/json",
                consumes="application/json")
org.springframework.http.ResponseEntity<AttributeCreateResponseDto> create(@PathVariable("dataSetListId")
 UUID dataSetListId,
 @NotNull @Valid @RequestParam(value="name",required=true)
 @NotNull @Valid String name,
 @NotNull @Valid @RequestParam(value="ordering",required=true)
 @NotNull @Valid Integer ordering,
 @NotNull @Valid @RequestParam(value="type",required=true)
 @NotNull @Valid AttributeTypeDto type,
 @Valid @RequestParam(value="typeDataSetListId",required=false)
 @Valid UUID typeDataSetListId,
 @Valid @RequestParam(value="modifiedWhen",required=false)
 @Valid Long modifiedWhen,
 @Valid @RequestBody(required=false)
 @Valid List<String> requestBody)

PUT /attribute/dsl/{dataSetListId} : Creates new attribute with provided name and order.

Parameters:

dataSetListId - dataSetListId (required)

name - name (required)

ordering - ordering (required)

type - type (required)

typeDataSetListId - typeDataSetListId (optional)

modifiedWhen - modifiedWhen (optional)

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)

createListValue

@RequestMapping(method=PUT,
                value="/attribute/{attributeId}/listValues",
                produces="application/json")
org.springframework.http.ResponseEntity<ListValueDto> createListValue(@PathVariable("attributeId")
 UUID attributeId,
 @NotNull @Valid @RequestParam(value="value",required=true)
 @NotNull @Valid String value,
 @Valid @RequestParam(value="dataSetListId",required=false)
 @Valid UUID dataSetListId,
 @Valid @RequestParam(value="modifiedWhen",required=false)
 @Valid Long modifiedWhen)

PUT /attribute/{attributeId}/listValues : Creates new list value for provided attribute.

Parameters:

attributeId - attributeId (required)

value - value (required)

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

createListValues

@RequestMapping(method=POST,
                value="/attribute/{attributeId}/listValues",
                produces="application/json",
                consumes="application/json")
org.springframework.http.ResponseEntity<List<UUID>> createListValues(@PathVariable("attributeId")
 UUID attributeId,
 @Valid @RequestParam(value="dataSetListId",required=false)
 @Valid UUID dataSetListId,
 @Valid @RequestParam(value="modifiedWhen",required=false)
 @Valid Long modifiedWhen,
 @Valid @RequestBody(required=false)
 @Valid List<String> requestBody)

POST /attribute/{attributeId}/listValues : Creates new list values for provided attribute by text.

Parameters:

attributeId - attributeId (required)

dataSetListId - dataSetListId (optional)

modifiedWhen - modifiedWhen (optional)

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)

delete

@RequestMapping(method=DELETE,
                value="/attribute/{attributeId}",
                produces="application/json")
org.springframework.http.ResponseEntity<Boolean> delete(@PathVariable("attributeId")
 UUID attributeId,
 @Valid @RequestParam(value="dataSetListId",required=false)
 @Valid UUID dataSetListId,
 @Valid @RequestParam(value="modifiedWhen",required=false)
 @Valid Long modifiedWhen)

DELETE /attribute/{attributeId} : Deletes selected attribute.

Parameters:

attributeId - attributeId (required)

dataSetListId - dataSetListId (optional)

modifiedWhen - modifiedWhen (optional)

Returns:

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

deleteAllByDsl

@RequestMapping(method=DELETE,
                value="/attribute/dsl/{dataSetListId}/all")
org.springframework.http.ResponseEntity<Void> deleteAllByDsl(@PathVariable("dataSetListId")
 UUID dataSetListId,
 @Valid @RequestParam(value="modifiedWhen",required=false)
 @Valid Long modifiedWhen)

DELETE /attribute/dsl/{dataSetListId}/all : Deletes attributes from the selected dataSetsList.

Parameters:

dataSetListId - dataSetListId (required)

modifiedWhen - modifiedWhen (optional)

Returns:

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

deleteListValue

@RequestMapping(method=DELETE,
                value="/attribute/{attributeId}/listValues/{listValueId}")
org.springframework.http.ResponseEntity<Void> deleteListValue(@PathVariable("attributeId")
 UUID attributeId,
 @PathVariable("listValueId")
 UUID listValueId,
 @Valid @RequestParam(value="dataSetListId",required=false)
 @Valid UUID dataSetListId,
 @Valid @RequestParam(value="modifiedWhen",required=false)
 @Valid Long modifiedWhen)

DELETE /attribute/{attributeId}/listValues/{listValueId} : Delete list value by id.

Parameters:

attributeId - attributeId (required)

listValueId - listValueId (required)

dataSetListId - dataSetListId (optional)

modifiedWhen - modifiedWhen (optional)

Returns:

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

get

@RequestMapping(method=GET,
                value="/attribute/{attributeId}",
                produces="application/json")
org.springframework.http.ResponseEntity<AttributeDto> get(@PathVariable("attributeId")
 UUID attributeId)

GET /attribute/{attributeId} : Returns attribute.

Parameters:

attributeId - attributeId (required)

Returns:

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

getAttributes

@RequestMapping(method=GET,
                value="/attribute/dsl/{dataSetListId}",
                produces="application/json")
org.springframework.http.ResponseEntity<List<AttributeDto>> getAttributes(@PathVariable("dataSetListId")
 UUID dataSetListId)

GET /attribute/dsl/{dataSetListId} : Returns all attributes by dataSetList id.

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)

getAttributesInItfFormat

@RequestMapping(method=GET,
                value="/attribute/dsl/{dataSetListId}/itf",
                produces="application/json")
org.springframework.http.ResponseEntity<Object> getAttributesInItfFormat(@PathVariable("dataSetListId")
 UUID dataSetListId)

GET /attribute/dsl/{dataSetListId}/itf : Returns all attributes by dataSetList id in itf format: [attr1.attr2, attr1].

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)

getOptions

@RequestMapping(method=GET,
                value="/attribute/{attributeId}/options",
                produces="application/json")
org.springframework.http.ResponseEntity<Object> getOptions(@PathVariable("attributeId")
 UUID attributeId)

GET /attribute/{attributeId}/options : getOptions

Parameters:

attributeId - attributeId (required)

Returns:

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

getParametersValuesAndDataSetIdsForAttributeValuesSorting

@RequestMapping(method=POST,
                value="/attribute/{dataSetListId}/existedValues",
                produces="application/json",
                consumes="application/json")
org.springframework.http.ResponseEntity<List<List>> getParametersValuesAndDataSetIdsForAttributeValuesSorting(@PathVariable("dataSetListId")
 UUID dataSetListId,
 @NotNull @Valid @RequestParam(value="targetAttrId",required=true)
 @NotNull @Valid UUID targetAttrId,
 @Valid @RequestBody(required=false)
 @Valid Map<String,Set<UUID>> requestBody)

POST /attribute/{dataSetListId}/existedValues : Sort Attribute values.

Parameters:

dataSetListId - dataSetListId (required)

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

rename

@RequestMapping(method=POST,
                value="/attribute/{attributeId}",
                produces="application/json")
org.springframework.http.ResponseEntity<Boolean> rename(@PathVariable("attributeId")
 UUID attributeId,
 @NotNull @Valid @RequestParam(value="name",required=true)
 @NotNull @Valid String name,
 @Valid @RequestParam(value="dataSetListId",required=false)
 @Valid UUID dataSetListId,
 @Valid @RequestParam(value="modifiedWhen",required=false)
 @Valid Long modifiedWhen)

POST /attribute/{attributeId} : Renames selected attribute.

Parameters:

attributeId - attributeId (required)

name - name (required)

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

setPosition

@RequestMapping(method=POST,
                value="/attribute/{attributeId}/position",
                consumes="application/json")
org.springframework.http.ResponseEntity<Void> setPosition(@PathVariable("attributeId")
 UUID attributeId,
 @Valid @RequestBody(required=false)
 @Valid Integer body)

POST /attribute/{attributeId}/position : Creates new list values for provided attribute by text.

Parameters:

attributeId - attributeId (required)

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

updateDslReference

@RequestMapping(method=POST,
                value="/attribute/{attributeId}/dataSetListReference",
                produces="application/json")
org.springframework.http.ResponseEntity<Boolean> updateDslReference(@PathVariable("attributeId")
 UUID attributeId,
 @Valid @RequestParam(value="value",required=false)
 @Valid UUID value)

POST /attribute/{attributeId}/dataSetListReference : Update DSL reference.

Parameters:

attributeId - attributeId (required)

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

updateOrdering

@RequestMapping(method=PUT,
                value="/attribute/updateOrdering",
                consumes="application/json")
org.springframework.http.ResponseEntity<Void> updateOrdering(@Valid @RequestBody(required=false)
 @Valid List<PairOfUUidAndIntDto> pairOfUUidAndIntDto)

PUT /attribute/updateOrdering : updateOrdering

Parameters:

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