Generate a LiveDoc

This is where you start a generation, with all the necessary options. Each of the desired outputs must be specified in the "outputs" array. If you do not specify any outputs, this endpoint will return a 4xx error. Note: Generated outputs are only available for download for 24 hours from time of generation

BODY PARAMETER DEFINITIONS

ADHOCINPUTS

Single variables are represented as an object such as:


{
    "name" : "field name here",
    "value" : "the value to pass in"
}

Adhoc tables are represented as an object with columns and a set of rows such as:


{
    "name": "adhoc_4",
    "value": {
        "columns": ["StrCol", "IntCol"],
        "rows": [["hello", 1], ["goodbye", 2]]
    }
}

OUTPUTS

  • imageDpi for PPT and DOC can be set to 0, 96, 120, 144, 200, 300, 400. When set to 0, we will use placeholders rather than rasterized images in place of dynamic images.
  • layout for PDF can be set to Full Page Slides or Notes Pages to produce slides or note pages
  • openPassword specifies the password required to open the PDF, if not provided, it will default to no password
  • ownerPassword specifies the password required to open the PDF as an edit mode owner, if not provided, it will default to no password

UseMinorVersionForTest

"UseMinorVersionForTest" is an optional parameter. Accepts true or false, defaults to false. If true, this parameter causes the LiveDoc to pull in all of the latest Minor version of the component, otherwise the LiveDoc will pull in the latest Major version of the component.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
string
required
Query Params
string
Body Params
adHocInputs
array of objects
adHocInputs
outputs
array of objects
required
length ≥ 1
outputs*
string
enum
required
Allowed:
string
string
pptxOptions
object
docxOptions
object
pdfOptions
object
xlsxOptions
object
boolean
Defaults to false
Response

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json