Skip to main content

Restore report version

POST https://api.rollstack.com/public/v1/reports/{id}/versions/{versionId}/restore

Takes a report of type SlideDeck back to one of its versions, as Restore in the app's Version history does: its slides, and the datasheets when the version saved them, become the version's, replacing every change made since, and members with the report open see it at once. Find the version with listReportVersions, or take a slides agent reply's versionBeforeId to undo that reply. The report as it was is saved first, and the answer names that version as versionBeforeId. Only its editors may, and not while the report is running or the slides agent is working on it.

Requires the slide_decks:write scope.

Operation ID: restoreReportVersion.

Path parameters

  • id (string, required): The report to act on, by its id from listReports or createReport. Only reports whose type is SlideDeck work here: another type, such as a Google Slides presentation, returns 400. You can also copy it from the report's link in Rollstack: it's the part right after /slides/.
  • versionId (string, required): The version to restore: an id from listReportVersions, or a reply's versionBeforeId.

Headers

  • Idempotency-Key (string): A unique value, such as a UUID, that makes retrying this call safe. A retry with the same key within 24 hours answers the first call's result instead of running it again. Use a new key for each new call. From 1 to 255 printable ASCII characters.

Response 200

Success

application/json

  • versionBeforeId (string, required): The version of the report saved just before the restore, with the slides and datasheets it replaced. Restore it to undo the restore.
  • skippedDatasheetIds (array of string, required): Datasheets the version had that stayed as they are now, because they read a source deleted since. Usually empty. A version saved before Rollstack kept datasheets in versions brings back only its slides.