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

Interface ParameterControllerApi

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

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<List<Object>>	bulkUpdateAttribute(UUID attributeId, @NotNull @Valid UUID dataSetListId, @Valid String value, org.springframework.core.io.Resource file, @Valid List<UUID> dataSetsIds, @Valid Long modifiedWhen, @Valid List<UUID> attrPathIds)	POST /parameter/bulk/attribute/{attributeId} : Bulk update value of parameters.
org.springframework.http.ResponseEntity<UUID>	create(UUID dataSetId, UUID attributeId, @Valid String value, @Valid UUID dataSetReference, @Valid UUID listValueReference, @Valid UUID dataSetListId, @Valid Long modifiedWhen)	PUT /parameter/ds/{dataSetId}/attribute/{attributeId} : Creates new parameter with provided text.
org.springframework.http.ResponseEntity<Void>	delete(@NotNull @Valid UUID dataSetId, @NotNull @Valid UUID attributeId, @Valid UUID dataSetListId, @Valid Long modifiedWhen)	DELETE /parameter : Deletes value of the selected parameter.
org.springframework.http.ResponseEntity<List<Object>>	getAffectedParametersByListValue(@Valid UUID listValueId, @Valid String full)	GET /parameter/affected/by/ : Get all parameters which uses provided ListValue
org.springframework.http.ResponseEntity<List<TableResponseDto>>	getAffectedParametersByListValues(@Valid List<UUID> UUID)	POST /parameter/affected/by/listValues : Get all parameters which use provided ListValue
org.springframework.http.ResponseEntity<List<ParameterDto>>	getDataSetParameters(UUID dataSetId)	GET /parameter/ds/{dataSetId} : Returns the parameters of selected DS.
org.springframework.http.ResponseEntity<ParameterDto>	getOriginalParameter(@NotNull @Valid UUID dataSetId, @NotNull @Valid UUID targetAttrId, @Valid UUID dataSetListId, @Valid Long modifiedWhen, @Valid List<UUID> UUID)	POST /parameter/get/original : getOriginalParameter
org.springframework.http.ResponseEntity<ParameterDto>	update(UUID dataSetId, UUID attributeId, @Valid String value, @Valid UUID dataSetReference, @Valid UUID listValueReference, @Valid UUID dataSetListId, @Valid Long modifiedWhen, @Valid List<UUID> UUID)	POST /parameter/ds/{dataSetId}/attribute/{attributeId} : Updates value of the selected parameter.
org.springframework.http.ResponseEntity<Void>	updateParameters(@NotNull @Valid UUID dataSetListId, @Valid String value, @Valid UUID dataSetReference, @Valid UUID listValueReference, @Valid Long modifiedWhen, @Valid UUID dataSetId, @Valid List<UUID> UUID)	POST /parameter/update/bulk : Updates value of the selected parameters.

Method Details

bulkUpdateAttribute

@RequestMapping(method=POST,
                value="/parameter/bulk/attribute/{attributeId}",
                produces="application/json")
org.springframework.http.ResponseEntity<List<Object>> bulkUpdateAttribute(@PathVariable("attributeId")
 UUID attributeId,
 @NotNull @Valid @RequestParam(value="dataSetListId",required=true)
 @NotNull @Valid UUID dataSetListId,
 @Valid @RequestParam(value="value",required=false)
 @Valid String value,
 @Valid @RequestParam(value="file",required=false)
 org.springframework.core.io.Resource file,
 @Valid @RequestParam(value="dataSetsIds",required=false)
 @Valid List<UUID> dataSetsIds,
 @Valid @RequestParam(value="modifiedWhen",required=false)
 @Valid Long modifiedWhen,
 @Valid @RequestParam(value="attrPathIds",required=false)
 @Valid List<UUID> attrPathIds)

POST /parameter/bulk/attribute/{attributeId} : Bulk update value of parameters.

Parameters:

attributeId - attributeId (required)

dataSetListId - dataSetListId (required)

value - value (optional)

file - file (optional)

dataSetsIds - dataSetsIds (optional)

modifiedWhen - modifiedWhen (optional)

attrPathIds - attrPathIds (optional)

Returns:

OK (status code 200) or Created (status code 201) or IM Used (status code 226) or Unauthorized (status code 401) or Forbidden (status code 403) or Not Found (status code 404)

create

@RequestMapping(method=PUT,
                value="/parameter/ds/{dataSetId}/attribute/{attributeId}",
                produces="application/json")
org.springframework.http.ResponseEntity<UUID> create(@PathVariable("dataSetId")
 UUID dataSetId,
 @PathVariable("attributeId")
 UUID attributeId,
 @Valid @RequestParam(value="value",required=false)
 @Valid String value,
 @Valid @RequestParam(value="dataSetReference",required=false)
 @Valid UUID dataSetReference,
 @Valid @RequestParam(value="listValueReference",required=false)
 @Valid UUID listValueReference,
 @Valid @RequestParam(value="dataSetListId",required=false)
 @Valid UUID dataSetListId,
 @Valid @RequestParam(value="modifiedWhen",required=false)
 @Valid Long modifiedWhen)

PUT /parameter/ds/{dataSetId}/attribute/{attributeId} : Creates new parameter with provided text.

Parameters:

dataSetId - dataSetId (required)

attributeId - attributeId (required)

value - value (optional)

dataSetReference - dataSetReference (optional)

listValueReference - listValueReference (optional)

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)

delete

@RequestMapping(method=DELETE,
                value="/parameter")
org.springframework.http.ResponseEntity<Void> delete(@NotNull @Valid @RequestParam(value="dataSetId",required=true)
 @NotNull @Valid UUID dataSetId,
 @NotNull @Valid @RequestParam(value="attributeId",required=true)
 @NotNull @Valid UUID attributeId,
 @Valid @RequestParam(value="dataSetListId",required=false)
 @Valid UUID dataSetListId,
 @Valid @RequestParam(value="modifiedWhen",required=false)
 @Valid Long modifiedWhen)

DELETE /parameter : Deletes value of the selected parameter.

Parameters:

dataSetId - dataSetId (required)

attributeId - attributeId (required)

dataSetListId - dataSetListId (optional)

modifiedWhen - modifiedWhen (optional)

Returns:

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

getAffectedParametersByListValue

@RequestMapping(method=GET,
                value="/parameter/affected/by/",
                produces="application/json")
org.springframework.http.ResponseEntity<List<Object>> getAffectedParametersByListValue(@Valid @RequestParam(value="listValueId",required=false)
 @Valid UUID listValueId,
 @Valid @RequestParam(value="full",required=false)
 @Valid String full)

GET /parameter/affected/by/ : Get all parameters which uses provided ListValue

Parameters:

listValueId - listValueId (optional)

full - full (optional)

Returns:

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

getAffectedParametersByListValues

@RequestMapping(method=POST,
                value="/parameter/affected/by/listValues",
                produces="application/json",
                consumes="application/json")
org.springframework.http.ResponseEntity<List<TableResponseDto>> getAffectedParametersByListValues(@Valid @RequestBody(required=false)
 @Valid List<UUID> UUID)

POST /parameter/affected/by/listValues : Get all parameters which use provided ListValue

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)

getDataSetParameters

@RequestMapping(method=GET,
                value="/parameter/ds/{dataSetId}",
                produces="application/json")
org.springframework.http.ResponseEntity<List<ParameterDto>> getDataSetParameters(@PathVariable("dataSetId")
 UUID dataSetId)

GET /parameter/ds/{dataSetId} : Returns the parameters of selected DS.

Parameters:

dataSetId - dataSetId (required)

Returns:

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

getOriginalParameter

@RequestMapping(method=POST,
                value="/parameter/get/original",
                produces="application/json",
                consumes="application/json")
org.springframework.http.ResponseEntity<ParameterDto> getOriginalParameter(@NotNull @Valid @RequestParam(value="dataSetId",required=true)
 @NotNull @Valid UUID dataSetId,
 @NotNull @Valid @RequestParam(value="targetAttrId",required=true)
 @NotNull @Valid UUID targetAttrId,
 @Valid @RequestParam(value="dataSetListId",required=false)
 @Valid UUID dataSetListId,
 @Valid @RequestParam(value="modifiedWhen",required=false)
 @Valid Long modifiedWhen,
 @Valid @RequestBody(required=false)
 @Valid List<UUID> UUID)

POST /parameter/get/original : getOriginalParameter

Parameters:

dataSetId - dataSetId (required)

targetAttrId - targetAttrId (required)

dataSetListId - dataSetListId (optional)

modifiedWhen - modifiedWhen (optional)

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)

update

@RequestMapping(method=POST,
                value="/parameter/ds/{dataSetId}/attribute/{attributeId}",
                produces="application/json",
                consumes="application/json")
org.springframework.http.ResponseEntity<ParameterDto> update(@PathVariable("dataSetId")
 UUID dataSetId,
 @PathVariable("attributeId")
 UUID attributeId,
 @Valid @RequestParam(value="value",required=false)
 @Valid String value,
 @Valid @RequestParam(value="dataSetReference",required=false)
 @Valid UUID dataSetReference,
 @Valid @RequestParam(value="listValueReference",required=false)
 @Valid UUID listValueReference,
 @Valid @RequestParam(value="dataSetListId",required=false)
 @Valid UUID dataSetListId,
 @Valid @RequestParam(value="modifiedWhen",required=false)
 @Valid Long modifiedWhen,
 @Valid @RequestBody(required=false)
 @Valid List<UUID> UUID)

POST /parameter/ds/{dataSetId}/attribute/{attributeId} : Updates value of the selected parameter.

Parameters:

dataSetId - dataSetId (required)

attributeId - attributeId (required)

value - value (optional)

dataSetReference - dataSetReference (optional)

listValueReference - listValueReference (optional)

dataSetListId - dataSetListId (optional)

modifiedWhen - modifiedWhen (optional)

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)

updateParameters

@RequestMapping(method=POST,
                value="/parameter/update/bulk",
                consumes="application/json")
org.springframework.http.ResponseEntity<Void> updateParameters(@NotNull @Valid @RequestParam(value="dataSetListId",required=true)
 @NotNull @Valid UUID dataSetListId,
 @Valid @RequestParam(value="value",required=false)
 @Valid String value,
 @Valid @RequestParam(value="dataSetReference",required=false)
 @Valid UUID dataSetReference,
 @Valid @RequestParam(value="listValueReference",required=false)
 @Valid UUID listValueReference,
 @Valid @RequestParam(value="modifiedWhen",required=false)
 @Valid Long modifiedWhen,
 @Valid @RequestParam(value="dataSetId",required=false)
 @Valid UUID dataSetId,
 @Valid @RequestBody(required=false)
 @Valid List<UUID> UUID)

POST /parameter/update/bulk : Updates value of the selected parameters. Please do not use for files or overlaps!

Parameters:

dataSetListId - dataSetListId (required)

value - value (optional)

dataSetReference - dataSetReference (optional)

listValueReference - listValueReference (optional)

modifiedWhen - modifiedWhen (optional)

dataSetId - dataSetId (optional)

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)