Skip to main content

Arrange slides

PATCH https://api.rollstack.com/public/v1/reports/{id}/slides

Moves, removes, hides or shows slides of a slide deck, with nothing on them changed. Read the slides' ids with getReportContent. order puts the slides in a new order and names every slide that stays, once each; remove takes slides out of the report; hide keeps a slide in the report but out of what is presented and exported, and show brings it back. Take the change back by restoring versionBeforeId with restoreReportVersion. Called with nothing to change, it answers every slide in order with whether it is hidden: getReportContent leaves hidden slides out. Only the report's editors may.

Requires the slide_decks:write scope.

Operation ID: arrangeReportSlides.

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/.

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

  • order (array of string): The report's slides in their new order, by their id from getReportContent: every slide that stays, once each. Leave it out to keep the order.
  • remove (array of string): The slides to remove from the report, by their ids.
  • hide (array of string): The slides to hide, by their ids: they stay in the report and are left out when it is presented or exported.
  • show (array of string): The hidden slides to show again, by their ids.

Response 200

Success

application/json

  • versionBeforeId (string): The version saved just before the change: restore it with restoreReportVersion to take the change back. Absent when nothing changed.
  • slides (array of object, required): The report's slides after the change, in order.
    • id (string, required): The slide.
    • hidden (boolean, required): Whether the slide is hidden.