Package org.qubership.atp.mia.controllers.api

Interface MiaHistoryChangesControllerApi

All Known Implementing Classes:

HistoryChangeController

@Generated(value="org.openapitools.codegen.languages.SpringCodegen",
           date="2025-09-12T06:34:49.113363471Z[Etc/UTC]")
@Validated
public interface MiaHistoryChangesControllerApi

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<HistoryItemResponseDto>	getAllHistory(UUID projectId, String itemType, UUID id, @Valid Integer offset, @Valid Integer limit)	GET /rest/history/{projectId}/{itemType}/{id} : finds all changes history for defined object
org.springframework.http.ResponseEntity<List<CompareEntityResponseDto>>	getEntitiesByVersion(UUID projectId, String itemType, UUID uuid, @NotNull @Valid List<String> versions)	GET /rest/entityversioning/{projectId}/{itemType}/{uuid} : getEntitiesByVersion
org.springframework.http.ResponseEntity<Void>	restoreToRevision(UUID projectId, String itemType, UUID id, Integer revisionId)	POST /rest/history/restore/{projectId}/{itemType}/{id}/revision/{revisionId} : Restore the state of the provided entity to defined revision

Method Details

getAllHistory

@RequestMapping(method=GET,
                value="/rest/history/{projectId}/{itemType}/{id}",
                produces="application/json")
org.springframework.http.ResponseEntity<HistoryItemResponseDto> getAllHistory(@PathVariable("projectId")
 UUID projectId,
 @PathVariable("itemType")
 String itemType,
 @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 /rest/history/{projectId}/{itemType}/{id} : finds all changes history for defined object

Parameters:

projectId - (required)

itemType - (required)

id - (required)

offset - (optional, default to 0)

limit - (optional, default to 10)

Returns:

OK (status code 200) or History for Entity type = '\" + itemType + \"' is not supported (status code 400) or Entity Id not found (status code 404)

getEntitiesByVersion

@RequestMapping(method=GET,
                value="/rest/entityversioning/{projectId}/{itemType}/{uuid}",
                produces="application/json")
org.springframework.http.ResponseEntity<List<CompareEntityResponseDto>> getEntitiesByVersion(@PathVariable("projectId")
 UUID projectId,
 @PathVariable("itemType")
 String itemType,
 @PathVariable("uuid")
 UUID uuid,
 @NotNull @Valid @RequestParam(value="versions",required=true)
 @NotNull @Valid List<String> versions)

GET /rest/entityversioning/{projectId}/{itemType}/{uuid} : getEntitiesByVersion

Parameters:

projectId - projectId (required)

itemType - itemType (required)

uuid - uuid (required)

versions - versions (required)

Returns:

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

restoreToRevision

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

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

Parameters:

projectId - (required)

itemType - (required)

id - (required)

revisionId - (required)

Returns:

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