v3

latestSwagger 2.02026-08-067506752.0 MB
template

Render a template by evaluating it against an existing job

post/v1/org/{orgId}/template/{templateId}/render

Path parameters

orgIdstring required

Org identifier (either id or slug)

templateIdstring required

Template id

Query parameters

jobIdstring

Job id

scenarioIdstring

Scenario id to query

datestring date

Date

format'TEXT' | 'HTML' | 'PDF' required

Format

changeGroupingType'PRIMARY' | 'SCENARIO' | 'COMP_REVIEW'

Type of change grouping

changeGroupingIdstring

Change grouping id to query (null for primary)

useScenarioChangesboolean

Generate documents for only the changes that are in the scenario. This option also allows you to reference the change within the template, which is otherwise not allowed

Response

template rendered

contentstring required