Skip to main content

Get slide drafts

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

The HTML drafts slides of a slide deck were made from, to change them and save them again with saveReportSlides under the same ids. A slide changed in Rollstack since its draft was saved, by a person in the editor or by Rollstack's agent, answers the draft as it was saved with changedInRollstack, the list of what was changed since: make every one of those changes in the draft first, so the work done there is kept, then make your own. A slide made by hand in the editor has no draft (html is null): a draft sent under its id rewrites the whole slide, dropping what was done there, so look at it with getReportSlideImages and ask the user first. At most 10 slides a call.

Requires the slide_decks:read scope.

Operation ID: getReportSlideHtml.

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

Query parameters

  • slideIds (string or array of string, required): The slides whose drafts to read, by their id from getReportContent or a reply's changedSlideIds, hidden ones included. Ids that are not slides of the report are ignored. 1 to 10 ids: repeat the parameter for each one, as in ?slideIds=a&slideIds=b. Example: f1e2d3c4-b5a6-4978-8a1b-2c3d4e5f6a7b.

Response 200

Success

application/json

  • slides (array of object, required): The slides asked for, in report order. Ids that are not slides of the report are left out.
    • id (string, required): The slide.
    • html (string or null, required): The draft the slide was made from, as one <section> of HTML. Null for a slide made by hand in the editor, which has none: a draft sent under its id rewrites the whole slide and drops what was done there. With changedInRollstack, the draft as it was saved, before those changes.
    • changedInRollstack (array of object): Only on a slide changed in Rollstack since its draft was saved, by a person in the editor or by Rollstack's agent: an entry per element changed, with was the element as the draft drew it and now as it stands. reworded: its text now reads now.text. moved: it sits in now's box. restyled: its font, colour, fill or grouping changed, so look at it with getReportSlideImages. removed has no now and added no was. html is the draft as saved, so it has none of them: make each in the draft before saving it, or saving drops it. Empty when the slide shows what the draft says again.
      • changes (array of string, required)
      • was (object or null, required)
        • kind (string, required): What it is, such as text, chart, table, data text, picture or shape.
        • text (string, required): Its words, or the template of a data text. Empty for an element without words.
        • left (number or null, required): Its box in canvas px, as far as a draft sets it: null where a data update does.
        • top (number or null, required)
        • width (number or null, required)
        • height (number or null, required)
        • rotation (number or null, required): In degrees.
      • now (object or null, required)
        • kind (string, required): What it is, such as text, chart, table, data text, picture or shape.
        • text (string, required): Its words, or the template of a data text. Empty for an element without words.
        • left (number or null, required): Its box in canvas px, as far as a draft sets it: null where a data update does.
        • top (number or null, required)
        • width (number or null, required)
        • height (number or null, required)
        • rotation (number or null, required): In degrees.