Versions
- OpenAPI 3.1.0 document: https://api.rollstack.com/public/v1/openapi.json
- The whole reference in Markdown: https://docs.rollstack.com/llms-full.txt
- An index of the reference: https://docs.rollstack.com/llms.txt
A slide deck's Version history, as in the app: Rollstack saves a version while the report is edited, around each run, before and after each change of the slides agent, and before a template is applied or a version restored.
Take a report back to a version with restoreReportVersion: to undo what the slides agent did, pass its reply's versionBeforeId. Find others with listReportVersions, and save one yourself with saveReportVersion before a change the user may want to take back. A restore saves the report as it was first, so it can be undone too.
List report versions
GET https://api.rollstack.com/public/v1/reports/{id}/versions
The Version history of a report of type SlideDeck, newest first, as the app lists it: the versions Rollstack saved while it was edited, run or changed by the slides agent, and those saved with saveReportVersion, each with what saved it. Answers up to limit versions, 20 by default and 100 at most, and a nextCursor: pass it as cursor for the next page, until it is null. Pass a version's id to restoreReportVersion to take the report back to it.
Requires the slide_decks:read scope.
Operation ID: listReportVersions.
Path parameters
id(string, required): The report to act on, by itsidfromlistReportsorcreateReport. Only reports whosetypeisSlideDeckwork here: another type, such as a Google Slides presentation, returns400. You can also copy it from the report's link in Rollstack: it's the part right after/slides/.
Query parameters
limit(integer): Maximum number of versions to return on this page, from 1 to 100. Defaults to20.cursor(string): Where to continue the list: pass thenextCursorreturned with the previous page to get the next one. Omit it for the first page. Example:6c1f9a2e-3b4d-4e8f-9a1b-2c3d4e5f6a7b.
Response 200
Success
application/json
data(array of object, required): The report's Version history, newest first: the versions it can be restored to.id(string, required): Identifies the version. Pass it asversionIdtorestoreReportVersion.name(string or null, required): The name the version was saved with, such asBefore applying Acmefor the one a template apply saves.nullwhen it has none: the app then names it after itskindor the time it was saved.kind(string, required): What saved the version.autoSaved: Rollstack, while the report was edited, and just before a version was restored or a template applied.saved: a member, withsaveReportVersion.beforeRun,afterRun: a run, just before and after it updated the report.beforeSlidesAgent,afterSlidesAgent: the slides agent, just before and after it changed the report. A reply'sversionBeforeIdnames the one before it.slidesAgent: an earlier version of the slides agent.
One of
autoSaved,saved,beforeRun,afterRun,beforeSlidesAgent,afterSlidesAgent,slidesAgent.savedBy(object or null, required): The member whose edit, run, message or call saved it.nullif their account was deleted.id(number, required): The member's user id, the same as theiridinlistMembers.name(string, required): The member's name, as shown in Rollstack.email(string, required): The member's email address.
createdAt(string (date-time), required): When the version was saved.
nextCursor(string or null, required): Pass it ascursorto get the next page of versions.nullwhen there are no more.
Save report version
POST https://api.rollstack.com/public/v1/reports/{id}/versions
Saves a report of type SlideDeck as it is now in its Version history, with an optional name, so it can be restored later with restoreReportVersion, for example before a change the user may want to take back. Rollstack already saves one before each change of the slides agent, each run and each template apply. Only its editors may. Each call saves another version.
Requires the slide_decks:write scope.
Operation ID: saveReportVersion.
Path parameters
id(string, required): The report to act on, by itsidfromlistReportsorcreateReport. Only reports whosetypeisSlideDeckwork here: another type, such as a Google Slides presentation, returns400. You can also copy it from the report's link in Rollstack: it's the part right after/slides/.
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.
Request body, required
application/json
name(string): A name for the version, as members will see it in the report's Version history, from 1 to 100 characters. Without one, the app names it after the time it was saved. Example:Before the Q3 restyle.
Response 201
Success
application/json
id(string, required): Identifies the version. Pass it asversionIdtorestoreReportVersion.name(string or null, required): The name the version was saved with, such asBefore applying Acmefor the one a template apply saves.nullwhen it has none: the app then names it after itskindor the time it was saved.kind(string, required): What saved the version.autoSaved: Rollstack, while the report was edited, and just before a version was restored or a template applied.saved: a member, withsaveReportVersion.beforeRun,afterRun: a run, just before and after it updated the report.beforeSlidesAgent,afterSlidesAgent: the slides agent, just before and after it changed the report. A reply'sversionBeforeIdnames the one before it.slidesAgent: an earlier version of the slides agent.
One of
autoSaved,saved,beforeRun,afterRun,beforeSlidesAgent,afterSlidesAgent,slidesAgent.savedBy(object or null, required): The member whose edit, run, message or call saved it.nullif their account was deleted.id(number, required): The member's user id, the same as theiridinlistMembers.name(string, required): The member's name, as shown in Rollstack.email(string, required): The member's email address.
createdAt(string (date-time), required): When the version was saved.
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 itsidfromlistReportsorcreateReport. Only reports whosetypeisSlideDeckwork here: another type, such as a Google Slides presentation, returns400. 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: anidfromlistReportVersions, or a reply'sversionBeforeId.
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.