Package org.qubership.atp.environments.service.rest.server.generated

Interface HistoryControllerApi

All Known Implementing Classes:

HistoryController

@Generated(value="org.openapitools.codegen.languages.SpringCodegen",
           date="2025-06-05T07:24:43.791338011Z[Etc/UTC]")
@Validated
public interface HistoryControllerApi

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<HistoryItemResponseDtoGenerated>	getAllHistory(UUID projectId, String itemType, UUID id, @Valid Integer offset, @Valid Integer limit)	GET /api/history/{projectId}/{itemType}/{id} : finds all changes history for defined object
org.springframework.http.ResponseEntity<List<CompareEntityResponseDtoGenerated>>	getEntitiesByVersion(UUID projectId, String itemType, UUID id, List<String> revisionIds)	GET /api/history/version/{projectId}/{itemType}/{id}/revision/{revisionIds} : finds all entity's states for provided version ids
org.springframework.http.ResponseEntity<Void>	restoreToRevision(UUID projectId, String itemType, UUID id, Integer revisionId)	POST /api/history/restore/{projectId}/{itemType}/{id}/revision/{revisionId} : Restore the state of the provided entity to defined revision

Method Details

getAllHistory

@RequestMapping(method=GET,
                value="/api/history/{projectId}/{itemType}/{id}",
                produces="application/json")
org.springframework.http.ResponseEntity<HistoryItemResponseDtoGenerated> 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 /api/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="/api/history/version/{projectId}/{itemType}/{id}/revision/{revisionIds}",
                produces="application/json")
org.springframework.http.ResponseEntity<List<CompareEntityResponseDtoGenerated>> getEntitiesByVersion(@PathVariable("projectId")
 UUID projectId,
 @PathVariable("itemType")
 String itemType,
 @PathVariable("id")
 UUID id,
 @PathVariable("revisionIds")
 List<String> revisionIds)

GET /api/history/version/{projectId}/{itemType}/{id}/revision/{revisionIds} : finds all entity's states for provided version ids

Parameters:

projectId - (required)

itemType - (required)

id - (required)

revisionIds - (required)

Returns:

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

restoreToRevision

@RequestMapping(method=POST,
                value="/api/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 /api/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:

Revision was restored successfully (status code 200) or Restore for Entity type = '\" + itemType + \"' is not supported (status code 400) or Forbidden (status code 403) or Entity Id not found (status code 404) or Revision was not restored. Reference to the one of the systems is invalid. (status code 500)