PrototypeDocuments

Endpoints to manage documents

Background

The formatting for a background color/image of a section (page), or slide/layout.

Properties

Name	Type	Description	Restrictions
color	Color¦null	The background color in RGB
image	string¦null	The id of the image resource

Example

{
  "color": {
    "blue": 255,
    "green": 255,
    "red": 255
  },
  "image": "Yn91IGZvdW5kIG1lIQ"
}

Document

Details about the document, including its ID and name

Properties

Name	Type	Description	Restrictions
created	Action	When the action was performed, and details about the user who did it	read-only
id	string	The unique identifier of the document	read-only
modified	Action	When the action was performed, and details about the user who did it	read-only
name	string	Name of the document	read-only
sections	[Section]	An array of information about the sections in the document. Included in the response only when the $expand query parameter is provided.	read-only
template	boolean	Whether the document is a template	read-only

Example

{
  "created": {
    "dateTime": "2021-05-13T20:41:35Z"
  },
  "id": "124efa2a142f472ba1ceab34ed18915f",
  "modified": {
    "dateTime": "2021-07-07T16:44:54Z"
  },
  "name": "Example Company 10-K",
  "sections": [
    {
      "children": [],
      "id": "124efa2a142f472ba1ceab34ed18915f_18",
      "index": 0,
      "name": "Introduction",
      "parent": null
    }
  ],
  "template": false
}

DocumentExport

Details about the document export, including its format and options

Properties

Name	Type	Description	Restrictions
docxOptions	DocumentToDocxOptions¦null	Optional options to export the document as a Microsoft Word document (.DOCX). If no options are provided, all options default to False.
format	string	The file format to export the document as.	required
pdfOptions	DocumentToPdfOptions¦null	Optional options to export the document as a portable document file (.PDF). If no options are provided, all options default to False.
sections	[string]	The IDs of the sections of the document to export. Omit to export the entire document.
xhtmlOptions	DocumentToXhtmlOptions¦null	Optional options to export the document as .XHTML. If no options are provided, editableXhtml will be true and all other options will be false.

Enumerated Values

Property	Value
format	pdf
format	docx
format	xhtml

Example

{
  "docxOptions": {
    "includeLeaderDots": true,
    "showTableCellShading": true
  },
  "format": "docx",
  "sections": [
    "a8b3adb687644b27fafcb3a9875f0f0d_18",
    "a8b3adb687644b27fafcb3a9875f0f0d_19"
  ]
}

DocumentToDocxOptions

Optional options to export the document as a Microsoft Word document (.DOCX). If no options are provided, all options default to False.

Properties

Name	Type	Description	Restrictions
includeLeaderDots	boolean	Whether to include leader dots when exporting to .DOCX. False by default.
showTableCellShading	boolean	Whether to show table cell shading when exporting to .DOCX. False by default.

Example

{
  "includeLeaderDots": true,
  "showTableCellShading": true
}

DocumentToPdfOptions

Optional options to export the document 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 when exporting to .PDF. False by default.
includeAttachmentLabels	boolean	Whether to include attachment labels 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.
includeTrackChanges	boolean	Whether to include track changes when exporting to .PDF. False by default.
removeSpaceFromPartialExport	boolean	Whether to remove space from partial exports 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,
  "includeAttachmentLabels": true,
  "includeComments": true,
  "includeDraftWatermark": true,
  "includeHyperlinks": true,
  "includeLeaderDots": true,
  "includeTrackChanges": true,
  "removeSpaceFromPartialExport": true,
  "tagForWebAccessibility": true,
  "useCmykColorspace": true
}

DocumentToXhtmlOptions

Optional options to export the document as .XHTML. If no options are provided, editableXhtml will be true and all other options will be false.

Properties

Name	Type	Description	Restrictions
editableSimple	boolean	Whether to produce simplified editable XHTML. This option produces editable XHTML that is simpler than the editableXHTML option. Use this option when you only need the textual and numeric content of a document, but not any of the images or complex formatting. When this option is true, all other XHTML export options must be false.
editableXhtml	boolean	Whether the resulting XHTML is editable when exporting to .XHTML. False by default. If set to true, other options must be false. When exporting XHTML that you plan to edit or modify, use this option. Otherwise, the export retains fidelity so it visually matches the document as it appears in the browser.
includeExternalHyperlinks	boolean	Whether to include external hyperlinks when exporting to .XHTML. False by default.
includeHeadersAndFooters	boolean	Whether to include the headers and footers when exporting to .XHTML. False by default.

Example

{
  "editableSimple": true,
  "editableXhtml": true,
  "includeExternalHyperlinks": true,
  "includeHeadersAndFooters": true
}

FooterProperties

Properties for footer of a section

Properties

Name	Type	Description	Restrictions
alternatingPage	boolean	Do the headers/footers alternate between even and odd, otherwise the odd header/footer is shown for both even and odd pages.
differentFirstPage	boolean	If the first page has different header/footer value
differentLastPage	boolean	If the last page has different header/footer value
margin	object¦null	Properties related to the margins of a header and footer
margin.left	number¦null	The left edge margin in points	Minimum: 0
margin.right	number¦null	The right edge margin in points	Minimum: 0
matchSectionMargins	boolean	Whether the margins match the section margins
positionFromBottom	number¦null	The position from the bottom for footer in points	Minimum: 0
sameAsPrevious	boolean	Whether the previous section’s headers/footers shown on this section

Example

{
  "alternatingPage": false,
  "differentFirstPage": false,
  "differentLastPage": false,
  "margin": {
    "left": 10,
    "right": 10
  },
  "matchSectionMargins": false,
  "positionFromBottom": 10,
  "sameAsPrevious": false
}

HeaderFooterProperties

Properties for header and footer of a section

Properties

Name	Type	Description	Restrictions
alternatingPage	boolean	Do the headers/footers alternate between even and odd, otherwise the odd header/footer is shown for both even and odd pages.
differentFirstPage	boolean	If the first page has different header/footer value
differentLastPage	boolean	If the last page has different header/footer value
margin	object¦null	Properties related to the margins of a header and footer
margin.left	number¦null	The left edge margin in points	Minimum: 0
margin.right	number¦null	The right edge margin in points	Minimum: 0
matchSectionMargins	boolean	Whether the margins match the section margins
sameAsPrevious	boolean	Whether the previous section’s headers/footers shown on this section

Example

{
  "alternatingPage": false,
  "differentFirstPage": false,
  "differentLastPage": false,
  "margin": {
    "left": 10,
    "right": 10
  },
  "matchSectionMargins": false,
  "sameAsPrevious": false
}

HeaderProperties

Properties for header of a section

Properties

Name	Type	Description	Restrictions
alternatingPage	boolean	Do the headers/footers alternate between even and odd, otherwise the odd header/footer is shown for both even and odd pages.
differentFirstPage	boolean	If the first page has different header/footer value
differentLastPage	boolean	If the last page has different header/footer value
margin	object¦null	Properties related to the margins of a header and footer
margin.left	number¦null	The left edge margin in points	Minimum: 0
margin.right	number¦null	The right edge margin in points	Minimum: 0
matchSectionMargins	boolean	Whether the margins match the section margins
positionFromTop	number¦null	Is the position from the top for header in points	Minimum: 0
sameAsPrevious	boolean	Whether the previous section’s headers/footers shown on this section

Example

{
  "alternatingPage": false,
  "differentFirstPage": false,
  "differentLastPage": false,
  "margin": {
    "left": 10,
    "right": 10
  },
  "matchSectionMargins": false,
  "positionFromTop": 10,
  "sameAsPrevious": false
}

HeadersFooters

Set of headers or footers for a section or as the defaults on a document. The odd header/footer will be used on even pages if the alternating property in the header/footer part of the section properties is set to false.

Properties

Name	Type	Description	Restrictions
even	RichTextRef¦null	Reference to the RichText for even pages	read-only
first	RichTextRef¦null	Reference to the RichText for the first header	read-only
last	RichTextRef¦null	Reference to the RichText for the last header	read-only
odd	RichTextRef¦null	Reference to the RichText for odd pages	read-only

Example

{
  "even": {
    "location": "string",
    "revision": "2B3C4D5E",
    "richText": "WA2NiYGJgm7cWr4W6Ka9BHScz56m2AT2FqTmBgekyk399M99I9Bb69BoEt3WHCag"
  },
  "first": {
    "location": "string",
    "revision": "2B3C4D5E",
    "richText": "WA2NiYGJgm7cWr4W6Ka9BHScz56m2AT2FqTmBgekyk399M99I9Bb69BoEt3WHCag"
  },
  "last": {
    "location": "string",
    "revision": "2B3C4D5E",
    "richText": "WA2NiYGJgm7cWr4W6Ka9BHScz56m2AT2FqTmBgekyk399M99I9Bb69BoEt3WHCag"
  },
  "odd": {
    "location": "string",
    "revision": "2B3C4D5E",
    "richText": "WA2NiYGJgm7cWr4W6Ka9BHScz56m2AT2FqTmBgekyk399M99I9Bb69BoEt3WHCag"
  }
}

LinksPublicationOptions

Options for publishing links.

Properties

Name	Type	Description	Restrictions
publishType	string	Whether or not all links should be published. When “ownLinks” only links one has last edited are published. When “allLinks” all links in document or presentation are published.	required

Enumerated Values

Property	Value
publishType	ownLinks
publishType	allLinks

Example

{
  "publishType": "ownLinks"
}

Margins

The margins of a rectangle for properties of objects such as a shape, text box, or page.

Properties

Name	Type	Description	Restrictions
bottom	number¦null	The bottom edge margin in points.	Minimum: 0
left	number¦null	The left edge margin in points.	Minimum: 0
right	number¦null	The right edge margin in points.	Minimum: 0
top	number¦null	The top edge margin in points.	Minimum: 0

Example

{
  "bottom": 10,
  "left": 10,
  "right": 10,
  "top": 10
}

PrototypeDocument

Details about the document, including its ID and name

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 document.
customFields	any	A map of ids to values representing Custom Fields on the document.
id	string	The unique identifier of the document	read-only
linksStatus	LinksStatus	Indicates the status for links in a document, presentation, or spreadsheet.	read-only
lock	DocumentLockType¦null	The type of lock applied to this document, if any. Note this property is not tied to revision and will always reflect the document’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 document	read-only
revision	string¦null	The current revision of the document	read-only
sectionCustomFieldGroups	[string]	An array of Custom Field Group IDs applied to all sections within the document.
template	boolean	Whether the document is a template	read-only

Example

{
  "created": {
    "dateTime": "2021-05-13T20:41:35Z"
  },
  "customFieldGroups": [],
  "customFields": {
    "com.workiva.gsr.legal_entity": "Workiva"
  },
  "id": "124efa2a142f472ba1ceab34ed18915f",
  "linksStatus": {
    "allLinks": "unpublished",
    "ownLinks": "published"
  },
  "lock": null,
  "modified": {
    "dateTime": "2021-07-07T16:44:54Z"
  },
  "name": "Example Company 10-K",
  "revision": "5B3C4D7B",
  "sectionCustomFieldGroups": [],
  "template": false
}

PrototypeDocumentFiltersReapplication

A document filter reapply operation, which can reapply filters to a document and optionally ignore read-only filters and force hide footnotes.

Properties

Name	Type	Description	Restrictions
forceHideFootnotes	boolean	Whether filters should be reapplied if doing so would cause footnotes to be hidden.
ignoreNonEditableFilters	boolean	Skip filters that cannot be reapplied (due to not having edit permissions or locked sections) instead of returning an error.

Example

{
  "forceHideFootnotes": true,
  "ignoreNonEditableFilters": true
}

PrototypeDocumentsListResult

Returns a JSON object with data and @nextLink properties. data contains a list of PrototypeDocument 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	[PrototypeDocument]	Details about the document, including its ID and name	required

Example

{
  "@nextLink": "<opaque_url>",
  "data": [
    {
      "created": {
        "dateTime": "2021-05-13T20:41:35Z"
      },
      "customFieldGroups": [],
      "customFields": {
        "com.workiva.gsr.legal_entity": "Workiva"
      },
      "id": "124efa2a142f472ba1ceab34ed18915f",
      "linksStatus": {
        "allLinks": "unpublished",
        "ownLinks": "published"
      },
      "lock": null,
      "modified": {
        "dateTime": "2021-07-07T16:44:54Z"
      },
      "name": "Example Company 10-K",
      "revision": "5B3C4D7B",
      "sectionCustomFieldGroups": [],
      "template": false
    }
  ]
}

PrototypeSection

Details about the section, including its ID and name.

Properties

Name	Type	Description	Restrictions
body	RichTextRef¦null	Reference to the RichText content for this section	read-only
children	[PrototypeSection]	An array of partial information about any sections within the section	read-only
customFields	any	A map of ids to values representing Custom Fields on the section.
drawingBody	DrawingRef¦null	Reference to the Drawing content for this section	read-only
footers	HeadersFooters¦null	Footers for this section	read-only
headers	HeadersFooters¦null	Headers for this section	read-only
id	string	The unique identifier of the section
index	integer	The integer index of the section relative to its parent section (or to the document if no parent section). The special value -1 may be used to position a section at the end of its siblings list.
lock	SectionLockType¦null	The type of lock applied to this section, if any. Note this property is not tied to revision and will always reflect the section’s current lock state.
name	string	The name of the section
nonPrinting	boolean	Whether or not the section is non-printing
parent	PrototypeSection¦null	The section’s ID and name
properties	SectionProperties¦null	Properties of this section	read-only
revision	string¦null	Current revision of this section	read-only

Example

{
  "body": {
    "location": "string",
    "revision": "2B3C4D5E",
    "richText": "WA2NiYGJgm7cWr4W6Ka9BHScz56m2AT2FqTmBgekyk399M99I9Bb69BoEt3WHCag"
  },
  "children": [
    {
      "id": "a8b3adb687644b27fafcb3a9875f0f0d_18",
      "name": "Risk factors",
      "revision": "5B3C4D7B"
    }
  ],
  "customFields": null,
  "drawingBody": {
    "drawing": "WA2NiYGJgm7cWr4W6Ka9BHScz56m2AT2FqTmBgekyk399M99I9Bb69BoEt3WHCag",
    "location": "string",
    "revision": "2c6438ab4541de6d"
  },
  "footers": {
    "even": {
      "location": "string",
      "revision": "2B3C4D5E",
      "richText": "WA2NiYGJgm7cWr4W6Ka9BHScz56m2AT2FqTmBgekyk399M99I9Bb69BoEt3WHCag"
    },
    "first": {
      "location": "string",
      "revision": "2B3C4D5E",
      "richText": "WA2NiYGJgm7cWr4W6Ka9BHScz56m2AT2FqTmBgekyk399M99I9Bb69BoEt3WHCag"
    },
    "last": {
      "location": "string",
      "revision": "2B3C4D5E",
      "richText": "WA2NiYGJgm7cWr4W6Ka9BHScz56m2AT2FqTmBgekyk399M99I9Bb69BoEt3WHCag"
    },
    "odd": {
      "location": "string",
      "revision": "2B3C4D5E",
      "richText": "WA2NiYGJgm7cWr4W6Ka9BHScz56m2AT2FqTmBgekyk399M99I9Bb69BoEt3WHCag"
    }
  },
  "headers": {
    "even": {
      "location": "string",
      "revision": "2B3C4D5E",
      "richText": "WA2NiYGJgm7cWr4W6Ka9BHScz56m2AT2FqTmBgekyk399M99I9Bb69BoEt3WHCag"
    },
    "first": {
      "location": "string",
      "revision": "2B3C4D5E",
      "richText": "WA2NiYGJgm7cWr4W6Ka9BHScz56m2AT2FqTmBgekyk399M99I9Bb69BoEt3WHCag"
    },
    "last": {
      "location": "string",
      "revision": "2B3C4D5E",
      "richText": "WA2NiYGJgm7cWr4W6Ka9BHScz56m2AT2FqTmBgekyk399M99I9Bb69BoEt3WHCag"
    },
    "odd": {
      "location": "string",
      "revision": "2B3C4D5E",
      "richText": "WA2NiYGJgm7cWr4W6Ka9BHScz56m2AT2FqTmBgekyk399M99I9Bb69BoEt3WHCag"
    }
  },
  "id": "a8b3adb687644b27fafcb3a9875f0f0d_18",
  "index": 1,
  "lock": "lock",
  "name": "Risk factors",
  "nonPrinting": true,
  "parent": {
    "id": "a8b3adb687644b27fafcb3a9875f0f0d_18",
    "name": "Risk factors",
    "revision": "5B3C4D7B"
  },
  "properties": {
    "background": {
      "color": {
        "blue": 43,
        "green": 85,
        "red": 111
      },
      "image": "Yn91IGZvdW5kIG1lIQ"
    },
    "edgarKeepTogether": false,
    "exhibit": false,
    "footerProperties": {
      "alternatingPage": false,
      "differentFirstPage": false,
      "differentLastPage": false,
      "margin": {
        "left": 10,
        "right": 10
      },
      "matchSectionMargins": false,
      "positionFromBottom": 10,
      "sameAsPrevious": false
    },
    "headerProperties": {
      "alternatingPage": false,
      "differentFirstPage": false,
      "differentLastPage": false,
      "margin": {
        "left": 10,
        "right": 10
      },
      "matchSectionMargins": false,
      "positionFromTop": 10,
      "sameAsPrevious": false
    },
    "margins": {
      "bottom": 10,
      "left": 10,
      "right": 10,
      "top": 10
    },
    "pageBreakBefore": false,
    "pageDimensions": {
      "height": 240,
      "width": 320
    },
    "pageNumber": {
      "reset": false,
      "startAt": 1
    },
    "restartFootnoteNumbering": false,
    "trackChanges": false
  },
  "revision": "5B3C4D7B"
}

PrototypeSectionsListResult

Returns a JSON object with data and @nextLink properties. data contains a list of Section 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	[PrototypeSection]	Details about the section, including its ID and name.	required

Example

{
  "@nextLink": "<opaque_url>",
  "data": [
    {
      "body": {
        "location": "string",
        "revision": "2B3C4D5E",
        "richText": "WA2NiYGJgm7cWr4W6Ka9BHScz56m2AT2FqTmBgekyk399M99I9Bb69BoEt3WHCag"
      },
      "children": [
        null
      ],
      "customFields": null,
      "drawingBody": {
        "drawing": "WA2NiYGJgm7cWr4W6Ka9BHScz56m2AT2FqTmBgekyk399M99I9Bb69BoEt3WHCag",
        "location": "string",
        "revision": "2c6438ab4541de6d"
      },
      "footers": {
        "even": {
          "location": "string",
          "revision": "2B3C4D5E",
          "richText": "WA2NiYGJgm7cWr4W6Ka9BHScz56m2AT2FqTmBgekyk399M99I9Bb69BoEt3WHCag"
        },
        "first": {
          "location": "string",
          "revision": "2B3C4D5E",
          "richText": "WA2NiYGJgm7cWr4W6Ka9BHScz56m2AT2FqTmBgekyk399M99I9Bb69BoEt3WHCag"
        },
        "last": {
          "location": "string",
          "revision": "2B3C4D5E",
          "richText": "WA2NiYGJgm7cWr4W6Ka9BHScz56m2AT2FqTmBgekyk399M99I9Bb69BoEt3WHCag"
        },
        "odd": {
          "location": "string",
          "revision": "2B3C4D5E",
          "richText": "WA2NiYGJgm7cWr4W6Ka9BHScz56m2AT2FqTmBgekyk399M99I9Bb69BoEt3WHCag"
        }
      },
      "headers": {
        "even": {
          "location": "string",
          "revision": "2B3C4D5E",
          "richText": "WA2NiYGJgm7cWr4W6Ka9BHScz56m2AT2FqTmBgekyk399M99I9Bb69BoEt3WHCag"
        },
        "first": {
          "location": "string",
          "revision": "2B3C4D5E",
          "richText": "WA2NiYGJgm7cWr4W6Ka9BHScz56m2AT2FqTmBgekyk399M99I9Bb69BoEt3WHCag"
        },
        "last": {
          "location": "string",
          "revision": "2B3C4D5E",
          "richText": "WA2NiYGJgm7cWr4W6Ka9BHScz56m2AT2FqTmBgekyk399M99I9Bb69BoEt3WHCag"
        },
        "odd": {
          "location": "string",
          "revision": "2B3C4D5E",
          "richText": "WA2NiYGJgm7cWr4W6Ka9BHScz56m2AT2FqTmBgekyk399M99I9Bb69BoEt3WHCag"
        }
      },
      "id": "a8b3adb687644b27fafcb3a9875f0f0d_18",
      "index": 1,
      "lock": "lock",
      "name": "Risk factors",
      "nonPrinting": true,
      "parent": null,
      "properties": {
        "background": {
          "color": {
            "blue": 43,
            "green": 85,
            "red": 111
          },
          "image": "Yn91IGZvdW5kIG1lIQ"
        },
        "edgarKeepTogether": false,
        "exhibit": false,
        "footerProperties": {
          "alternatingPage": false,
          "differentFirstPage": false,
          "differentLastPage": false,
          "margin": {
            "left": 10,
            "right": 10
          },
          "matchSectionMargins": false,
          "positionFromBottom": 10,
          "sameAsPrevious": false
        },
        "headerProperties": {
          "alternatingPage": false,
          "differentFirstPage": false,
          "differentLastPage": false,
          "margin": {
            "left": 10,
            "right": 10
          },
          "matchSectionMargins": false,
          "positionFromTop": 10,
          "sameAsPrevious": false
        },
        "margins": {
          "bottom": 10,
          "left": 10,
          "right": 10,
          "top": 10
        },
        "pageBreakBefore": false,
        "pageDimensions": {
          "height": 240,
          "width": 320
        },
        "pageNumber": {
          "reset": false,
          "startAt": 1
        },
        "restartFootnoteNumbering": false,
        "trackChanges": false
      },
      "revision": "5B3C4D7B"
    }
  ]
}

Section

Details about the section, including its ID and name.

Properties

Name	Type	Description	Restrictions
children	[Section]	An array of partial information about any sections within the section	read-only
id	string	The unique identifier of the section
index	integer	The integer index of the section relative to its parent section (or to the document if no parent section). The special value -1 may be used to position a section at the end of its siblings list.	read-only
name	string	The name of the section
nonPrinting	boolean	Whether or not the section is non-printing
parent	Section¦null	The section’s ID and name

Example

{
  "id": "a8b3adb687644b27fafcb3a9875f0f0d_18",
  "name": "Risk factors",
  "nonPrinting": false,
  "parent": null
}

SectionEdit

An edit to a section

Properties

Name	Type	Description	Restrictions
clearLock	ClearSectionLockEdit	Clears the selected section’s lock value
setLock	SetSectionLockEdit	Updates the selected section’s lock to the set value
setNonPrinting	SetNonPrintingEdit	Updates sections nonPrinting to the set value
type	SectionEditType	The type of the section edit	required

Example

{
  "setNonPrinting": {
    "nonPrinting": true,
    "selection": [
      "9fdff0887cb5425292dfb1fdd759753a_35",
      "9fdff0887cb5425292dfb1fdd759753a_50"
    ]
  },
  "type": "setNonPrinting"
}

SectionEditType

The type of the section edit

Properties

Name	Type	Description	Restrictions
anonymous	string	The type of the section edit

Enumerated Values

Property	Value
anonymous	clearLock
anonymous	setLock
anonymous	setNonPrinting

Example

"clearLock"

SectionLockType

A lock applied to a section.

Properties

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

Enumerated Values

Property	Value
anonymous	lock

Example

"lock"

SectionProperties

Section properties are the configurations and setup for the section.

Properties

Name	Type	Description	Restrictions
background	Background	The formatting for a background color/image of a section (page), or slide/layout.
edgarKeepTogether	boolean¦null	Determines if page breaks should be ignored for this section in Edgar export
exhibit	boolean¦null	Whether or not the section is an exhibit
footer	FooterProperties	Properties for the footer
header	HeaderProperties	Properties for the header
margins	Margins	Margins for each page
pageBreakBefore	boolean	Whether or not there should be a page break before the section
pageDimensions	Dimensions¦null	Dimensions of each page
pageNumber	object	Page number properties
pageNumber.reset	boolean	Whether the page numbers should restart at the section
pageNumber.startAt	integer	The page number to start numbering at in this section	Minimum: 1
restartFootnoteNumbering	boolean	Whether or not to restart footnote numbering in the section
trackChanges	boolean	Whether or not track changes is enabled

Example

{
  "background": {
    "color": {
      "blue": 43,
      "green": 85,
      "red": 111
    },
    "image": "Yn91IGZvdW5kIG1lIQ"
  },
  "edgarKeepTogether": false,
  "exhibit": false,
  "footerProperties": {
    "alternatingPage": false,
    "differentFirstPage": false,
    "differentLastPage": false,
    "margin": {
      "left": 10,
      "right": 10
    },
    "matchSectionMargins": false,
    "positionFromBottom": 10,
    "sameAsPrevious": false
  },
  "headerProperties": {
    "alternatingPage": false,
    "differentFirstPage": false,
    "differentLastPage": false,
    "margin": {
      "left": 10,
      "right": 10
    },
    "matchSectionMargins": false,
    "positionFromTop": 10,
    "sameAsPrevious": false
  },
  "margins": {
    "bottom": 10,
    "left": 10,
    "right": 10,
    "top": 10
  },
  "pageBreakBefore": false,
  "pageDimensions": {
    "height": 240,
    "width": 320
  },
  "pageNumber": {
    "reset": false,
    "startAt": 1
  },
  "restartFootnoteNumbering": false,
  "trackChanges": false
}

SectionRef

A reference to a section in a document outline

Properties

Name	Type	Description	Restrictions
document	string	The unique identifier of the document containing the section being referred to	read-only
location	string¦null	❗️ Deprecated: A URL that a GET request can be made against to retrieve this section	read-only
revision	string	The revision of the document and section being referred to	read-only
section	string	The unique identifier of the section being referred to	read-only

Example

{
  "document": "16b1f641613847469b7aa1ca29af40b1",
  "location": "<opaque_url>",
  "revision": "2B3C4D5E",
  "section": "16b1f641613847469b7aa1ca29af40b1_650855815308"
}

SectionsEdits

A collection of section edits to perform

Properties

Name	Type	Description	Restrictions
data	[SectionEdit]	The collection of edits	required, Minimum items: 1, Maximum items: 240

Example

{
  "data": [
    {
      "setNonPrinting": {
        "nonPrinting": true,
        "selection": [
          "9fdff0887cb5425292dfb1fdd759753a_35",
          "9fdff0887cb5425292dfb1fdd759753a_50"
        ]
      },
      "type": "setNonPrinting"
    },
    {
      "setNonPrinting": {
        "nonPrinting": false,
        "selection": [
          "9fdff0887cb5425292dfb1fdd759753a_45",
          "9fdff0887cb5425292dfb1fdd759753a_40"
        ]
      },
      "type": "setNonPrinting"
    }
  ]
}

SectionSelection

A selection of one or more sections

Properties

None

Example

[
  "e34730f79a144b1b8977aa8884c208ee_321",
  "e34730f79a144b1b8977aa8884c208ee_123"
]

SectionsListResult

Returns a JSON object with data and @nextLink properties. data contains a list of Section 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	[Section]	Details about the section, including its ID and name.	required

Example

{
  "@nextLink": "<opaque_url>",
  "data": [
    {
      "id": "a8b3adb687644b27fafcb3a9875f0f0d_18",
      "name": "Risk factors",
      "nonPrinting": false,
      "parent": null
    }
  ]
}

SetNonPrintingEdit

Updates sections nonPrinting to the set value

Properties

Name	Type	Description	Restrictions
nonPrinting	boolean	Whether or not to set the nonPrinting property on the specified selection of sections	required
selection	SectionSelection	A selection of one or more sections	required

Example

{
  "nonPrinting": true,
  "selection": [
    "9fdff0887cb5425292dfb1fdd759753a_35",
    "9fdff0887cb5425292dfb1fdd759753a_50"
  ]
}