/documenttemplates/{templateId}/render

post

https://api.dev.orbit.do/v5/documenttemplates/{templateId}/render

Render a document template to PDF and optionally create document links.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

templateId

uuid

required

The unique identifier of the document template to render

Body Params

Render a document template to a PDF: resolve the supplied data object ids to entities, fill the template's HTML, convert to PDF, and store it. Optionally create DocumentLinks to attach it to entities.

dataObjectIds

object

required

Map of data object type to its id (e.g. { tour:

language

string

enum

Defaults to de

Language to render the template in; defaults to 'de', falling back to another language if the chosen one is absent from the template.

Allowed:

documentLinks

array of objects

Optional links to create, associating the generated document with entities.

documentLinks

upsert

boolean

When true, append a new version to the document already filed for this template + documentLinks[0] key instead of creating a new one. Requires exactly one documentLinks entry. Serialize concurrent upserts against the same document (they can collide on versionId).

Responses

400

Bad request - missing required data objects, invalid entity IDs, or template rendering error

401

Unauthorized - invalid or missing API key

404

Document template not found

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Document successfully rendered and saved to DMS