Package org.qubership.atp.dataset.service.rest.server

Interface HistoryControllerApi

All Known Implementing Classes:

HistoryController

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

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<HistoryItemResponseDto>	getAllHistory(UUID projectId, UUID id, @Valid Integer offset, @Valid Integer limit)	GET /api/history/{projectId}/datasetlist/{id} : Finds all changes history for defined data set list
org.springframework.http.ResponseEntity<UiManDataSetListJDto>	getRevisionDetails(UUID projectId, UUID entityId, Integer revision)	GET /api/history/{projectId}/datasetlist/revisionDetails/{entityId}/{revision} : Find model of Dataset List by revision
org.springframework.http.ResponseEntity<Void>	restoreToRevision(UUID projectId, UUID id, Integer revisionId)	POST /api/history/restore/{projectId}/datasetlist/{id}/revision/{revisionId} : Restore the state of the provided entity to defined revision

Method Details

getAllHistory

@RequestMapping(method=GET,
                value="/api/history/{projectId}/datasetlist/{id}",
                produces="application/json")
org.springframework.http.ResponseEntity<HistoryItemResponseDto> getAllHistory(@PathVariable("projectId")
 UUID projectId,
 @PathVariable("id")
 UUID id,
 @Valid @RequestParam(value="offset",required=false,defaultValue="0")
 @Valid Integer offset,
 @Valid @RequestParam(value="limit",required=false,defaultValue="10")
 @Valid Integer limit)

GET /api/history/{projectId}/datasetlist/{id} : Finds all changes history for defined data set list

Parameters:

projectId - (required)

id - (required)

offset - (optional, default to 0)

limit - (optional, default to 10)

Returns:

OK (status code 200) or Entity Id not found (status code 404)

getRevisionDetails

@RequestMapping(method=GET,
                value="/api/history/{projectId}/datasetlist/revisionDetails/{entityId}/{revision}",
                produces="application/json")
org.springframework.http.ResponseEntity<UiManDataSetListJDto> getRevisionDetails(@PathVariable("projectId")
 UUID projectId,
 @PathVariable("entityId")
 UUID entityId,
 @PathVariable("revision")
 Integer revision)

GET /api/history/{projectId}/datasetlist/revisionDetails/{entityId}/{revision} : Find model of Dataset List by revision

Parameters:

projectId - (required)

entityId - (required)

revision - (required)

Returns:

OK (status code 200) or Entity Id not found (status code 404)

restoreToRevision

@RequestMapping(method=POST,
                value="/api/history/restore/{projectId}/datasetlist/{id}/revision/{revisionId}")
org.springframework.http.ResponseEntity<Void> restoreToRevision(@PathVariable("projectId")
 UUID projectId,
 @PathVariable("id")
 UUID id,
 @PathVariable("revisionId")
 Integer revisionId)

POST /api/history/restore/{projectId}/datasetlist/{id}/revision/{revisionId} : Restore the state of the provided entity to defined revision

Parameters:

projectId - (required)

id - (required)

revisionId - (required)

Returns:

Revision was restored successfully (status code 200) or Forbidden (status code 403) or Entity Id not found (status code 404) or Revision was not restored (status code 500)