Presentations

Endpoints to manage presentations

Presentation

Details about the presentation, including its ID, name, and milestone dates.

Properties

Name	Type	Description	Restrictions
created	Action	When the action was performed, and details about the user who did it	read-only
customFieldGroups	[string]	An array of Custom Field Group IDs applied to the presentation.
customFields	any	A map of ids to values representing Custom Fields on the presentation.
id	string	The unique identifier of the presentation	read-only
lock	PresentationLockType¦null	The type of lock applied to this presentation, if any. Note this property is not tied to revision and will always reflect the presentation’s current lock state.
modified	Action	When the action was performed, and details about the user who did it	read-only
name	string	Name of the presentation	read-only
revision	string¦null	The current revision of the presentation	read-only
slideCustomFieldGroups	[string]	An array of Custom Field Group IDs applied to all slides within the presentation.
template	boolean	Whether the presentation is a template	read-only

Example

{
  "created": {
    "dateTime": "2020-10-28T15:03:27Z"
  },
  "customFieldGroups": [],
  "customFields": {
    "com.workiva.gsr.legal_entity": "Workiva"
  },
  "id": "124efa2a142f472ba1ceab34ed18915f",
  "lock": null,
  "modified": {
    "dateTime": "2020-10-28T15:03:27Z"
  },
  "name": "2019 Year-End Summary",
  "slideCustomFieldGroups": [],
  "template": false
}

PresentationExport

Details about the presentation export, including its format and options

Properties

Name	Type	Description	Restrictions
format	string	The file format to export the presentation as - .PDF or .PPTX.	required
pdfOptions	PresentationToPdfOptions¦null	Optional options to export the presentation as a portable document file (.PDF). If no options are provided, all options default to False.
pptxOptions	PresentationToPptxOptions¦null	Optional options to export the presentation as a Microsoft Powerpoint File (.pptx). If no options are provided, all options default to False.
slides	[string]	The IDs of the slides of the presentation to export. Omit to export the entire presentation.

Enumerated Values

Property	Value
format	pdf
format	pptx

Example

{
  "format": "pptx",
  "pptxOptions": {
    "includeUnusedLayoutSlides": true
  },
  "slides": [
    "a8b3adb687644b27fafcb3a9875f0f0d_18",
    "a8b3adb687644b27fafcb3a9875f0f0d_19"
  ]
}

PresentationFiltersReapplication

A presentation filter reapply operation, which can reapply filters to a presentation and optionally ignore read-only filters.

Properties

Name	Type	Description	Restrictions
ignoreNonEditableFilters	boolean	Skip filters that cannot be reapplied (due to not having edit permissions or locked sections) instead of returning an error.

Example

{
  "ignoreNonEditableFilters": true
}

PresentationLockType

The type of the presentation lock.

Properties

Name	Type	Description	Restrictions
anonymous	string	The type of the presentation lock.

Enumerated Values

Property	Value
anonymous	locked

Example

"locked"

PresentationRef

A reference to a presentation

Properties

Name	Type	Description	Restrictions
location	string¦null	❗️ Deprecated: A URL that a GET request can be made against to retrieve this presentation	read-only
presentation	string	The unique identifier of the presentation being referred to	read-only
revision	Revision	Identifies a unique revision of content. The same revision can be used for any content request within a file because revisions are allocated at the file-level. When querying for content, this can be used to get a consistent version of the content. When editing content, this can be used to make the change to the content at a known state. In either case, omitting the revision (when allowed) will always default to the latest revision of the file.	read-only

Example

{
  "location": "<opaque_url>",
  "presentation": "16b1f641613847469b7aa1ca29af40b1",
  "revision": "2B3C4D5E"
}

PresentationsListResult

Returns a JSON object with data and @nextLink properties. data contains a list of Presentation objects, and @nextLink provides the URL to the next set of results. If there are no additional results, @nextLink doesn’t appear. If the request returns no results at all, data contains an empty array.

Properties

Name	Type	Description	Restrictions
@nextLink	string	Pagination link for next set of results
data	[Presentation]	Details about the presentation, including its ID, name, and milestone dates.	required

Example

{
  "@nextLink": "<opaque_url>",
  "data": [
    {
      "created": {
        "dateTime": "2020-10-28T15:03:27Z"
      },
      "customFieldGroups": [],
      "customFields": {
        "com.workiva.gsr.legal_entity": "Workiva"
      },
      "id": "124efa2a142f472ba1ceab34ed18915f",
      "lock": null,
      "modified": {
        "dateTime": "2020-10-28T15:03:27Z"
      },
      "name": "2019 Year-End Summary",
      "slideCustomFieldGroups": [],
      "template": false
    }
  ]
}

PresentationToPdfOptions

Optional options to export the presentation as a portable document file (.PDF). If no options are provided, all options default to False.

Properties

Name	Type	Description	Restrictions
includeAlternateRowFill	boolean	Whether to include alternate row fill in the presentation’s tables when exporting to .PDF. False by default.
includeComments	boolean	Whether to include comments when exporting to .PDF. False by default. When True, all comments are included, even those already resolved.
includeDraftWatermark	boolean	Whether to include a “Draft” watermark when exporting to .PDF. False by default.
includeHyperlinks	boolean	Whether to include hyperlinks when exporting to .PDF. False by default.
includeLeaderDots	boolean	Whether to include leader dots when exporting to .PDF. False by default.
tagForWebAccessibility	boolean	Whether to tag for web accessibility when exporting to .PDF. False by default.
useCmykColorspace	boolean	Whether to use CMYK colorspace when exporting to .PDF. False by default.

Example

{
  "includeAlternateRowFill": true,
  "includeComments": true,
  "includeDraftWatermark": true,
  "includeHyperlinks": true,
  "includeLeaderDots": true,
  "tagForWebAccessibility": true,
  "useCmykColorspace": true
}

PresentationToPptxOptions

Optional options to export the presentation as a Microsoft Powerpoint File (.pptx). If no options are provided, all options default to False.

Properties

Name	Type	Description	Restrictions
includeUnusedLayoutSlides	boolean	Whether to include unused layout slides. False by default.

Example

{
  "includeUnusedLayoutSlides": true
}

Slide

Details about the slide, including its ID and name.

Properties

Name	Type	Description	Restrictions
children	[Slide]	An array of partial information about any slides within the slide.	read-only
customFields	any	A map of ids to values representing Custom Fields on the slide.
id	string	The unique identifier of the slide	read-only
index	integer	The integer index of the slide relative to its parent slide (or to the presentation if no parent slide). The special value -1 may be used to position a slide at the end of its siblings list.
layoutSource	string¦null	The ID of the slide layout from which this slide’s layout is derived.
lock	SlideLockType¦null	The type of lock applied to this slide, if any. Note this property is not tied to revision and will always reflect the slide’s current lock state.
name	string	The name of the slide
parent	Slide¦null	The slide’s ID and name
revision	string	The revision of the slide	read-only
slideBody	DrawingRef	Reference to the Drawing content for this slide	read-only

Example

{
  "children": [
    {
      "id": "a8b3adb687644b27fafcb3a9875f0f0d_18",
      "name": "Risk factors"
    }
  ],
  "customFields": null,
  "id": "a8b3adb687644b27fafcb3a9875f0f0d_18",
  "index": 1,
  "layoutSource": "a8b3adb687644b27fafcb3a9875f0f0d_1",
  "lock": "lock",
  "name": "Risk factors",
  "parent": {
    "id": "a8b3adb687644b27fafcb3a9875f0f0d_18",
    "name": "Risk factors"
  },
  "revision": "24601abc",
  "slideBody": {
    "drawing": "WA2NiYGJgm7cWr4W6Ka9BHScz56m2AT2FqTmBgekyk399M99I9Bb69BoEt3WHCag",
    "location": "string",
    "revision": "2c6438ab4541de6d"
  }
}

SlideCopy

Details about the destination presentation and, optionally, the destination slide.

Properties

Name	Type	Description	Restrictions
presentation	string	The unique identifier of the presentation to copy a slide into	required
slideIndex	integer	The integer index of where within the siblings to place the new slide; 0 by default. To place the slide at the end of its siblings, use the special value -1.
slideLayoutSource	string¦null	The ID of the layout slide from which this slide’s layout is to be derived. Must exist within the destination presentation.
slideName	string¦null	The name of the new slide, if different than the source slide.

Example

{
  "presentation": "327afa1a152f372fa1aeadb35ed28925d",
  "slideIndex": 2,
  "slideLayoutSource": "717ada1a252a373fa6aeddb15ea28725a_1",
  "slideName": "October 2020"
}

SlideLayout

Details about the slide layout, including its ID and name.

Properties

Name	Type	Description	Restrictions
id	string	The unique identifier of the slide layout	read-only
index	integer	The integer index of the slide relative to its parent slide layout (or to the presentation if no parent slide layout). The special value -1 may be used to position a slide at the end of its siblings list.
lock	SlideLayoutLockType¦null	The type of lock applied to this slide layout, if any. Note this property is not tied to revision and will always reflect the slide layout’s current lock state.
name	string	The name of the slide layout
revision	string	The revision of the slide layout	read-only
slideLayoutBody	DrawingRef	Reference to the Drawing content for this slide layout	read-only

Example

{
  "id": "a8b3adb687644b27fafcb3a9875f0f0d_18",
  "index": 1,
  "lock": "lock",
  "name": "Title Page",
  "revision": "24601abc",
  "slideLayoutBody": {
    "drawing": "WA2NiYGJgm7cWr4W6Ka9BHScz56m2AT2FqTmBgekyk399M99I9Bb69BoEt3WHCag",
    "location": "string",
    "revision": "2c6438ab4541de6d"
  }
}

SlideLayoutCopy

Details about the destination presentation and, optionally, the destination slide layout.

Properties

Name	Type	Description	Restrictions
presentation	string	The unique identifier of the presentation to copy a slide layout into	required
slideLayoutIndex	integer	The integer index of where within the siblings to place the new slide layout; 0 by default. To place the slide at the end of its siblings, use the special value -1.
slideLayoutName	string¦null	The name of the new slide layout, if different than the source slide layout.
slideLayoutParent	string¦null	The ID of the parent slide layout to copy the slide layout into. To place the slide layout at the top level of the presentation, use the default null.

Example

{
  "presentation": "327afa1a152f372fa1aeadb35ed28925d",
  "slideLayoutIndex": 2,
  "slideLayoutName": "Title Page",
  "slideLayoutParent": "327afa1a152f372fa1aeadb35ed28925d_14"
}

SlideLayoutLockType

A lock applied to a slide layout.

Properties

Name	Type	Description	Restrictions
anonymous	string	A lock applied to a slide layout.

Enumerated Values

Property	Value
anonymous	lock

Example

"lock"

SlideLayoutsListResult

Returns a JSON object with data and @nextLink properties. data contains a list of SlideLayout objects, and @nextLink provides the URL to the next set of results. If there are no additional results, @nextLink doesn’t appear. If the request returns no results at all, data contains an empty array.

Properties

Name	Type	Description	Restrictions
@nextLink	string	Pagination link for next set of results
data	[SlideLayout]	Details about the slide layout, including its ID and name.	required

Example

{
  "@nextLink": "<opaque_url>",
  "data": [
    {
      "id": "a8b3adb687644b27fafcb3a9875f0f0d_18",
      "index": 1,
      "lock": "lock",
      "name": "Title Page",
      "revision": "24601abc",
      "slideLayoutBody": {
        "drawing": "WA2NiYGJgm7cWr4W6Ka9BHScz56m2AT2FqTmBgekyk399M99I9Bb69BoEt3WHCag",
        "location": "string",
        "revision": "2c6438ab4541de6d"
      }
    }
  ]
}

SlideLockType

A lock applied to a slide.

Properties

Name	Type	Description	Restrictions
anonymous	string	A lock applied to a slide.

Enumerated Values

Property	Value
anonymous	lock

Example

"lock"

SlideRef

A reference to a slide in a presentation outline

Properties

Name	Type	Description	Restrictions
location	string¦null	❗️ Deprecated: A URL that a GET request can be made against to retrieve this slide	read-only
presentation	string	The unique identifier of the presentation containing the slide being referred to	read-only
revision	Revision	Identifies a unique revision of content. The same revision can be used for any content request within a file because revisions are allocated at the file-level. When querying for content, this can be used to get a consistent version of the content. When editing content, this can be used to make the change to the content at a known state. In either case, omitting the revision (when allowed) will always default to the latest revision of the file.	read-only
slide	string	The unique identifier of the slide being referred to	read-only

Example

{
  "location": "<opaque_url>",
  "presentation": "16b1f641613847469b7aa1ca29af40b1",
  "revision": "2B3C4D5E",
  "slide": "16b1f641613847469b7aa1ca29af40b1_650855815308"
}

SlideRelative

Represents the position of a drawing relative to the top-left corner a slide.

Properties

Name	Type	Description	Restrictions
x	number	The horizontal offset in points typically from the left edge.
y	number	The vertical offset in points typically from the top edge where larger numbers are further down/

Example

{
  "x": 0,
  "y": 0
}

SlidesListResult

Returns a JSON object with data and @nextLink properties. data contains a list of Slide objects, and @nextLink provides the URL to the next set of results. If there are no additional results, @nextLink doesn’t appear. If the request returns no results at all, data contains an empty array.

Properties

Name	Type	Description	Restrictions
@nextLink	string	Pagination link for next set of results
data	[Slide]	Details about the slide, including its ID and name.	required

Example

{
  "@nextLink": "<opaque_url>",
  "data": [
    {
      "children": [
        null
      ],
      "customFields": null,
      "id": "a8b3adb687644b27fafcb3a9875f0f0d_18",
      "index": 1,
      "layoutSource": "a8b3adb687644b27fafcb3a9875f0f0d_1",
      "lock": "lock",
      "name": "Risk factors",
      "parent": null,
      "revision": "24601abc",
      "slideBody": {
        "drawing": "WA2NiYGJgm7cWr4W6Ka9BHScz56m2AT2FqTmBgekyk399M99I9Bb69BoEt3WHCag",
        "location": "string",
        "revision": "2c6438ab4541de6d"
      }
    }
  ]
}