Package org.qubership.atp.dataset.clients.api

Interface DataSetControllerApi

All Known Subinterfaces:

DataSetFeignClient

@Generated(value="org.openapitools.codegen.languages.SpringCodegen",
           date="2025-06-11T14:57:02.355991791Z[Etc/UTC]")
@Validated
public interface DataSetControllerApi

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<LabelDto>	addLabel(UUID dataSetId, @NotNull @Valid String name, @Valid UUID dataSetListId, @Valid Long modifiedWhen)	PUT /ds/{dataSetId}/label : addLabel
org.springframework.http.ResponseEntity<UUID>	copy(UUID dataSetId, @NotNull @Valid String name)	PUT /ds/{dataSetId}/copy : Copy DS with name provided.
org.springframework.http.ResponseEntity<UUID>	create(UUID dataSetListId, @NotNull @Valid String name, @Valid Long modifiedWhen)	PUT /ds/{dataSetListId}/ds : Creates new DS with name provided.
org.springframework.http.ResponseEntity<Void>	delete(UUID dataSetId, @Valid UUID dataSetListId, @Valid Long modifiedWhen)	DELETE /ds/{dataSetId} : Deletes selected DS.
org.springframework.http.ResponseEntity<Boolean>	deleteLabel(UUID dataSetId, UUID labelId, @Valid UUID dataSetListId, @Valid Long modifiedWhen)	DELETE /ds/{dataSetId}/label/{labelId} : deleteLabel
org.springframework.http.ResponseEntity<List<TableResponseDto>>	getAffectedDataSets(UUID dataSetId)	GET /ds/{dataSetId}/affectedDatasets : Returns all affected dataSets by specified reference with pagination support.
org.springframework.http.ResponseEntity<List<Object>>	getAffectedDataSetsByChangesDataSetReference(@NotNull @Valid UUID dsReferenceId, @Valid String full)	GET /ds/dsReferenceId/affected/by : Returns all affected dataSets by changes at reference value.
org.springframework.http.ResponseEntity<BigDecimal>	getAffectedDataSetsCount(UUID dataSetId)	GET /ds/{dataSetId}/affectedDatasetsCount : Returns all affected dataSets count by specified reference.
org.springframework.http.ResponseEntity<DataSetTreeDto>	getAtpContextFull(UUID dataSetId, @Valid String evaluate, @Valid String body)	POST /ds/{dataSetId}/atp : Returns dataSet by id in ITF format + atp macros
org.springframework.http.ResponseEntity<List<Object>>	getAtpContextFullBulk(UUID dataSetId, @Valid String evaluate, @Valid Integer countOfEvaluates, @Valid Map<String,String> requestBody)	POST /ds/{dataSetId}/atp/bulk : Returns dataSet by id in ITF format + atp macros
org.springframework.http.ResponseEntity<DataSetTreeDto>	getAtpContextObject(UUID dataSetId, @Valid String evaluate, @Valid String body)	POST /ds/{dataSetId}/atp/object : Returns dataSet by id in ITF format + atp macros
org.springframework.http.ResponseEntity<List<Object>>	getAtpContextObjectBulk(UUID dataSetId, @Valid String evaluate, @Valid Integer countOfEvaluates, @Valid Map<String,String> requestBody)	POST /ds/{dataSetId}/atp/object/bulk : Returns dataSet by id in ITF format + atp macros
org.springframework.http.ResponseEntity<DataSetTreeDto>	getAtpContextObjectExtended(UUID dataSetId, @Valid String evaluate, @Valid String body)	POST /ds/{dataSetId}/atp/objectExtended : Returns dataSet by id in ATP format + atp macros
org.springframework.http.ResponseEntity<DataSetTreeDto>	getAtpContextOptimized(UUID dataSetId, @Valid String evaluate, @Valid String body)	POST /ds/{dataSetId}/atp/optimized : Returns dataSet by id in ITF format + atp macros
org.springframework.http.ResponseEntity<List<Object>>	getAtpContextOptimizedBulk(UUID dataSetId, @Valid String evaluate, @Valid Integer countOfEvaluates, @Valid Map<String,String> requestBody)	POST /ds/{dataSetId}/atp/optimized/bulk : Returns dataSet by id in ITF format + atp macros
org.springframework.http.ResponseEntity<Object>	getDataSetById(UUID dataSetId)	GET /ds/{dataSetId} : Returns dataSet by id.
org.springframework.http.ResponseEntity<List<Object>>	getDataSets()	GET /ds : Returns all dataSets.
org.springframework.http.ResponseEntity<List<Object>>	getDataSetsByIds(@Valid List<UUID> UUID)	POST /ds/listOfDatasets : Returns dataSets by id-s.
org.springframework.http.ResponseEntity<PageAbstractEntityResponseDto>	getDataSetsByName(@NotNull @Valid String name, @NotNull @Valid UUID projectId, @Valid Long offset, @Valid Integer pageNumber, @Valid Integer pageSize, @Valid Boolean paged, @Valid Boolean sortSorted, @Valid Boolean sortUnsorted, @Valid Boolean unpaged)	GET /ds/find-name-pagination : Returns all dataSets.
org.springframework.http.ResponseEntity<Object>	getDataSetsForAtp(String dataSetId, @Valid String evaluate, @Valid String body)	POST /ds/{dataSetId}/legacy/atp : Returns dataSet by id in ITF format + atp macros
org.springframework.http.ResponseEntity<List<Object>>	getDatasetsOrTableResponseAffectedByChangeParameterValue(@NotNull @Valid UUID dataSetId, @NotNull @Valid UUID attributeId, @Valid String full)	GET /ds/affected/by : Returns all affected datasets by changes at attribute.
org.springframework.http.ResponseEntity<List<ObjectShortResponseDto>>	getDataSetsShort(UUID dataSetListId)	GET /ds/{dataSetListId}/short : Returns list of Datasets (id + name) for selected DSL.
org.springframework.http.ResponseEntity<Object>	getInItfFormat(String dataSetId)	GET /ds/{dataSetId}/legacy/itf : Returns dataSet by id in ITF format: {attribute = parameter, attribute2 : {attribute = parameter2}}.
org.springframework.http.ResponseEntity<String>	getItfContext(UUID dataSetId)	GET /ds/{dataSetId}/itf : Returns dataSet by id in ITF format + atp macros
org.springframework.http.ResponseEntity<List<LabelDto>>	getLabels(UUID dataSetId)	GET /ds/{dataSetId}/label : getLabels
org.springframework.http.ResponseEntity<PairOfUUidAndIntDto>	getPath(@NotNull @Valid UUID dsId)	GET /ds/parent/path : returns visibility area and data set list ids
org.springframework.http.ResponseEntity<UiManAttributeDto>	getUiAttribute(UUID dataSetId, @Valid String evaluate, @Valid List<UUID> UUID)	POST /ds/{dataSetId}/parameters : getUiAttribute
org.springframework.http.ResponseEntity<Void>	lock(@NotNull @Valid UUID dataSetListId, @NotNull @Valid Boolean locked, @Valid Long modifiedWhen, @Valid List<UUID> UUID)	POST /ds/lock/update : Lock DS from change.
org.springframework.http.ResponseEntity<Void>	rename(UUID dataSetId, @NotNull @Valid String name, @Valid UUID dataSetListId, @Valid Long modifiedWhen)	POST /ds/{dataSetId} : Renames DS.
org.springframework.http.ResponseEntity<ParameterDto>	resetOverriddenParameter(@NotNull @Valid UUID dataSetId, @NotNull @Valid UUID targetAttrId, @Valid UUID dataSetListId, @Valid Long modifiedWhen, @Valid List<UUID> UUID)	POST /ds/reset/by : Reset all selected datasets, at changed attribute.
org.springframework.http.ResponseEntity<Void>	restAffectedDatasetsByChangesAttribute(@Valid UUID attributeId, @Valid UUID dataSetListId, @Valid Long modifiedWhen, @Valid List<UUID> UUID)	POST /ds/reset/affected/by : Reset all selected datasets, at changed attribute
org.springframework.http.ResponseEntity<Boolean>	restore(@Valid UUID dataSetListId, @Valid Long modifiedWhen, @Valid Object body)	POST /ds/restore : restore
org.springframework.http.ResponseEntity<Void>	setPosition(UUID dataSetId, @Valid Integer body)	POST /ds/{dataSetId}/position : Creates new list values for provided attribute by text.

Method Details

addLabel

@RequestMapping(method=PUT,
                value="/ds/{dataSetId}/label",
                produces="application/json")
org.springframework.http.ResponseEntity<LabelDto> addLabel(@PathVariable("dataSetId")
 UUID dataSetId,
 @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)

PUT /ds/{dataSetId}/label : addLabel

Parameters:

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

copy

@RequestMapping(method=PUT,
                value="/ds/{dataSetId}/copy",
                produces="application/json")
org.springframework.http.ResponseEntity<UUID> copy(@PathVariable("dataSetId")
 UUID dataSetId,
 @NotNull @Valid @RequestParam(value="name",required=true)
 @NotNull @Valid String name)

PUT /ds/{dataSetId}/copy : Copy DS with name provided.

Parameters:

dataSetId - dataSetId (required)

name - name (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=PUT,
                value="/ds/{dataSetListId}/ds",
                produces="application/json")
org.springframework.http.ResponseEntity<UUID> create(@PathVariable("dataSetListId")
 UUID dataSetListId,
 @NotNull @Valid @RequestParam(value="name",required=true)
 @NotNull @Valid String name,
 @Valid @RequestParam(value="modifiedWhen",required=false)
 @Valid Long modifiedWhen)

PUT /ds/{dataSetListId}/ds : Creates new DS with name provided.

Parameters:

dataSetListId - dataSetListId (required)

name - name (required)

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="/ds/{dataSetId}")
org.springframework.http.ResponseEntity<Void> delete(@PathVariable("dataSetId")
 UUID dataSetId,
 @Valid @RequestParam(value="dataSetListId",required=false)
 @Valid UUID dataSetListId,
 @Valid @RequestParam(value="modifiedWhen",required=false)
 @Valid Long modifiedWhen)

DELETE /ds/{dataSetId} : Deletes selected DS.

Parameters:

dataSetId - dataSetId (required)

dataSetListId - dataSetListId (optional)

modifiedWhen - modifiedWhen (optional)

Returns:

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

deleteLabel

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

DELETE /ds/{dataSetId}/label/{labelId} : deleteLabel

Parameters:

dataSetId - dataSetId (required)

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

getAffectedDataSets

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

GET /ds/{dataSetId}/affectedDatasets : Returns all affected dataSets by specified reference with pagination support.

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)

getAffectedDataSetsByChangesDataSetReference

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

GET /ds/dsReferenceId/affected/by : Returns all affected dataSets by changes at reference value.

Parameters:

dsReferenceId - dsReferenceId (required)

full - full (optional)

Returns:

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

getAffectedDataSetsCount

@RequestMapping(method=GET,
                value="/ds/{dataSetId}/affectedDatasetsCount",
                produces="application/json")
org.springframework.http.ResponseEntity<BigDecimal> getAffectedDataSetsCount(@PathVariable("dataSetId")
 UUID dataSetId)

GET /ds/{dataSetId}/affectedDatasetsCount : Returns all affected dataSets count by specified reference.

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)

getAtpContextFull

@RequestMapping(method=POST,
                value="/ds/{dataSetId}/atp",
                produces="application/json",
                consumes="application/json")
org.springframework.http.ResponseEntity<DataSetTreeDto> getAtpContextFull(@PathVariable("dataSetId")
 UUID dataSetId,
 @Valid @RequestParam(value="evaluate",required=false)
 @Valid String evaluate,
 @Valid @RequestBody(required=false)
 @Valid String body)

POST /ds/{dataSetId}/atp : Returns dataSet by id in ITF format + atp macros

Parameters:

dataSetId - dataSetId (required)

evaluate - evaluate (optional)

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)

getAtpContextFullBulk

@RequestMapping(method=POST,
                value="/ds/{dataSetId}/atp/bulk",
                produces="application/json",
                consumes="application/json")
org.springframework.http.ResponseEntity<List<Object>> getAtpContextFullBulk(@PathVariable("dataSetId")
 UUID dataSetId,
 @Valid @RequestParam(value="evaluate",required=false)
 @Valid String evaluate,
 @Valid @RequestParam(value="countOfEvaluates",required=false)
 @Valid Integer countOfEvaluates,
 @Valid @RequestBody(required=false)
 @Valid Map<String,String> requestBody)

POST /ds/{dataSetId}/atp/bulk : Returns dataSet by id in ITF format + atp macros

Parameters:

dataSetId - dataSetId (required)

evaluate - evaluate (optional)

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

getAtpContextObject

@RequestMapping(method=POST,
                value="/ds/{dataSetId}/atp/object",
                produces="application/json",
                consumes="application/json")
org.springframework.http.ResponseEntity<DataSetTreeDto> getAtpContextObject(@PathVariable("dataSetId")
 UUID dataSetId,
 @Valid @RequestParam(value="evaluate",required=false)
 @Valid String evaluate,
 @Valid @RequestBody(required=false)
 @Valid String body)

POST /ds/{dataSetId}/atp/object : Returns dataSet by id in ITF format + atp macros

Parameters:

dataSetId - dataSetId (required)

evaluate - evaluate (optional)

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)

getAtpContextObjectBulk

@RequestMapping(method=POST,
                value="/ds/{dataSetId}/atp/object/bulk",
                produces="application/json",
                consumes="application/json")
org.springframework.http.ResponseEntity<List<Object>> getAtpContextObjectBulk(@PathVariable("dataSetId")
 UUID dataSetId,
 @Valid @RequestParam(value="evaluate",required=false)
 @Valid String evaluate,
 @Valid @RequestParam(value="countOfEvaluates",required=false)
 @Valid Integer countOfEvaluates,
 @Valid @RequestBody(required=false)
 @Valid Map<String,String> requestBody)

POST /ds/{dataSetId}/atp/object/bulk : Returns dataSet by id in ITF format + atp macros

Parameters:

dataSetId - dataSetId (required)

evaluate - evaluate (optional)

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

getAtpContextObjectExtended

@RequestMapping(method=POST,
                value="/ds/{dataSetId}/atp/objectExtended",
                produces="application/json",
                consumes="application/json")
org.springframework.http.ResponseEntity<DataSetTreeDto> getAtpContextObjectExtended(@PathVariable("dataSetId")
 UUID dataSetId,
 @Valid @RequestParam(value="evaluate",required=false)
 @Valid String evaluate,
 @Valid @RequestBody(required=false)
 @Valid String body)

POST /ds/{dataSetId}/atp/objectExtended : Returns dataSet by id in ATP format + atp macros

Parameters:

dataSetId - dataSetId (required)

evaluate - evaluate (optional)

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)

getAtpContextOptimized

@RequestMapping(method=POST,
                value="/ds/{dataSetId}/atp/optimized",
                produces="application/json",
                consumes="application/json")
org.springframework.http.ResponseEntity<DataSetTreeDto> getAtpContextOptimized(@PathVariable("dataSetId")
 UUID dataSetId,
 @Valid @RequestParam(value="evaluate",required=false)
 @Valid String evaluate,
 @Valid @RequestBody(required=false)
 @Valid String body)

POST /ds/{dataSetId}/atp/optimized : Returns dataSet by id in ITF format + atp macros

Parameters:

dataSetId - dataSetId (required)

evaluate - evaluate (optional)

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)

getAtpContextOptimizedBulk

@RequestMapping(method=POST,
                value="/ds/{dataSetId}/atp/optimized/bulk",
                produces="application/json",
                consumes="application/json")
org.springframework.http.ResponseEntity<List<Object>> getAtpContextOptimizedBulk(@PathVariable("dataSetId")
 UUID dataSetId,
 @Valid @RequestParam(value="evaluate",required=false)
 @Valid String evaluate,
 @Valid @RequestParam(value="countOfEvaluates",required=false)
 @Valid Integer countOfEvaluates,
 @Valid @RequestBody(required=false)
 @Valid Map<String,String> requestBody)

POST /ds/{dataSetId}/atp/optimized/bulk : Returns dataSet by id in ITF format + atp macros

Parameters:

dataSetId - dataSetId (required)

evaluate - evaluate (optional)

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

getDataSetById

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

GET /ds/{dataSetId} : Returns dataSet by id.

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)

getDataSets

@RequestMapping(method=GET,
                value="/ds",
                produces="application/json")
org.springframework.http.ResponseEntity<List<Object>> getDataSets()

GET /ds : Returns all dataSets.

Returns:

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

getDataSetsByIds

@RequestMapping(method=POST,
                value="/ds/listOfDatasets",
                produces="application/json",
                consumes="application/json")
org.springframework.http.ResponseEntity<List<Object>> getDataSetsByIds(@Valid @RequestBody(required=false)
 @Valid List<UUID> UUID)

POST /ds/listOfDatasets : Returns dataSets by id-s.

Parameters:

UUID - (optional)

Returns:

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

getDataSetsByName

@RequestMapping(method=GET,
                value="/ds/find-name-pagination",
                produces="application/json")
org.springframework.http.ResponseEntity<PageAbstractEntityResponseDto> getDataSetsByName(@NotNull @Valid @RequestParam(value="name",required=true)
 @NotNull @Valid String name,
 @NotNull @Valid @RequestParam(value="projectId",required=true)
 @NotNull @Valid UUID projectId,
 @Valid @RequestParam(value="offset",required=false)
 @Valid Long offset,
 @Valid @RequestParam(value="pageNumber",required=false)
 @Valid Integer pageNumber,
 @Valid @RequestParam(value="pageSize",required=false)
 @Valid Integer pageSize,
 @Valid @RequestParam(value="paged",required=false)
 @Valid Boolean paged,
 @Valid @RequestParam(value="sort.sorted",required=false)
 @Valid Boolean sortSorted,
 @Valid @RequestParam(value="sort.unsorted",required=false)
 @Valid Boolean sortUnsorted,
 @Valid @RequestParam(value="unpaged",required=false)
 @Valid Boolean unpaged)

GET /ds/find-name-pagination : Returns all dataSets.

Parameters:

name - name (required)

projectId - projectId (required)

offset - (optional)

pageNumber - (optional)

pageSize - (optional)

paged - (optional)

sortSorted - (optional)

sortUnsorted - (optional)

unpaged - (optional)

Returns:

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

getDataSetsForAtp

@RequestMapping(method=POST,
                value="/ds/{dataSetId}/legacy/atp",
                produces="application/json",
                consumes="application/json")
org.springframework.http.ResponseEntity<Object> getDataSetsForAtp(@PathVariable("dataSetId")
 String dataSetId,
 @Valid @RequestParam(value="evaluate",required=false)
 @Valid String evaluate,
 @Valid @RequestBody(required=false)
 @Valid String body)

POST /ds/{dataSetId}/legacy/atp : Returns dataSet by id in ITF format + atp macros

Parameters:

dataSetId - dataSetId (required)

evaluate - evaluate (optional)

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)

getDataSetsShort

@RequestMapping(method=GET,
                value="/ds/{dataSetListId}/short",
                produces="application/json")
org.springframework.http.ResponseEntity<List<ObjectShortResponseDto>> getDataSetsShort(@PathVariable("dataSetListId")
 UUID dataSetListId)

GET /ds/{dataSetListId}/short : Returns list of Datasets (id + name) for selected DSL.

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)

getDatasetsOrTableResponseAffectedByChangeParameterValue

@RequestMapping(method=GET,
                value="/ds/affected/by",
                produces="application/json")
org.springframework.http.ResponseEntity<List<Object>> getDatasetsOrTableResponseAffectedByChangeParameterValue(@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="full",required=false)
 @Valid String full)

GET /ds/affected/by : Returns all affected datasets by changes at attribute.

Parameters:

dataSetId - dataSetId (required)

attributeId - attributeId (required)

full - full (optional)

Returns:

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

getInItfFormat

@RequestMapping(method=GET,
                value="/ds/{dataSetId}/legacy/itf",
                produces="application/json")
org.springframework.http.ResponseEntity<Object> getInItfFormat(@PathVariable("dataSetId")
 String dataSetId)

GET /ds/{dataSetId}/legacy/itf : Returns dataSet by id in ITF format: {attribute = parameter, attribute2 : {attribute = parameter2}}.

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)

getItfContext

@RequestMapping(method=GET,
                value="/ds/{dataSetId}/itf",
                produces="application/json")
org.springframework.http.ResponseEntity<String> getItfContext(@PathVariable("dataSetId")
 UUID dataSetId)

GET /ds/{dataSetId}/itf : Returns dataSet by id in ITF format + atp macros

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)

getLabels

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

GET /ds/{dataSetId}/label : getLabels

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)

getPath

@RequestMapping(method=GET,
                value="/ds/parent/path",
                produces="application/json")
org.springframework.http.ResponseEntity<PairOfUUidAndIntDto> getPath(@NotNull @Valid @RequestParam(value="dsId",required=true)
 @NotNull @Valid UUID dsId)

GET /ds/parent/path : returns visibility area and data set list ids

Parameters:

dsId - dsId (required)

Returns:

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

getUiAttribute

@RequestMapping(method=POST,
                value="/ds/{dataSetId}/parameters",
                produces="application/json",
                consumes="application/json")
org.springframework.http.ResponseEntity<UiManAttributeDto> getUiAttribute(@PathVariable("dataSetId")
 UUID dataSetId,
 @Valid @RequestParam(value="evaluate",required=false)
 @Valid String evaluate,
 @Valid @RequestBody(required=false)
 @Valid List<UUID> UUID)

POST /ds/{dataSetId}/parameters : getUiAttribute

Parameters:

dataSetId - dataSetId (required)

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

lock

@RequestMapping(method=POST,
                value="/ds/lock/update",
                consumes="application/json")
org.springframework.http.ResponseEntity<Void> lock(@NotNull @Valid @RequestParam(value="dataSetListId",required=true)
 @NotNull @Valid UUID dataSetListId,
 @NotNull @Valid @RequestParam(value="locked",required=true)
 @NotNull @Valid Boolean locked,
 @Valid @RequestParam(value="modifiedWhen",required=false)
 @Valid Long modifiedWhen,
 @Valid @RequestBody(required=false)
 @Valid List<UUID> UUID)

POST /ds/lock/update : Lock DS from change.

Parameters:

dataSetListId - dataSetListId (required)

locked - locked ds flag (required)

modifiedWhen - modifiedWhen (optional)

UUID - (optional)

Returns:

Created (status code 201) or No Content (status code 204) or Unauthorized (status code 401) or Forbidden (status code 403) or Not Found (status code 404)

rename

@RequestMapping(method=POST,
                value="/ds/{dataSetId}")
org.springframework.http.ResponseEntity<Void> rename(@PathVariable("dataSetId")
 UUID dataSetId,
 @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 /ds/{dataSetId} : Renames DS.

Parameters:

dataSetId - dataSetId (required)

name - name (required)

dataSetListId - dataSetListId (optional)

modifiedWhen - modifiedWhen (optional)

Returns:

Created (status code 201) or No Content (status code 204) or Unauthorized (status code 401) or Forbidden (status code 403) or Not Found (status code 404)

resetOverriddenParameter

@RequestMapping(method=POST,
                value="/ds/reset/by",
                produces="application/json",
                consumes="application/json")
org.springframework.http.ResponseEntity<ParameterDto> resetOverriddenParameter(@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 /ds/reset/by : Reset all selected datasets, at changed attribute. dataSetIds is ids of datasets in which we want to reset overridden parameters with attributeId provided

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)

restAffectedDatasetsByChangesAttribute

@RequestMapping(method=POST,
                value="/ds/reset/affected/by",
                consumes="application/json")
org.springframework.http.ResponseEntity<Void> restAffectedDatasetsByChangesAttribute(@Valid @RequestParam(value="attributeId",required=false)
 @Valid 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<UUID> UUID)

POST /ds/reset/affected/by : Reset all selected datasets, at changed attribute

Parameters:

attributeId - attributeId (optional)

dataSetListId - dataSetListId (optional)

modifiedWhen - modifiedWhen (optional)

UUID - (optional)

Returns:

Created (status code 201) or No Content (status code 204) or Unauthorized (status code 401) or Forbidden (status code 403) or Not Found (status code 404)

restore

@RequestMapping(method=POST,
                value="/ds/restore",
                produces="application/json",
                consumes="application/json")
org.springframework.http.ResponseEntity<Boolean> restore(@Valid @RequestParam(value="dataSetListId",required=false)
 @Valid UUID dataSetListId,
 @Valid @RequestParam(value="modifiedWhen",required=false)
 @Valid Long modifiedWhen,
 @Valid @RequestBody(required=false)
 @Valid Object body)

POST /ds/restore : restore

Parameters:

dataSetListId - dataSetListId (optional)

modifiedWhen - modifiedWhen (optional)

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)

setPosition

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

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

Parameters:

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