Rendering

API for starting template rendering from arbitrary XML

This API accepts arbitrary well-formed XML as rendering data and starts document rendering asynchronously. The XML root element is preserved in the rendering data. How the XML becomes rendering data: - Element and attribute names are lower-cased and every character outside `[a-zA-Z0-9_]` becomes `_`. Two sibling elements or two attributes on the same element whose names collapse onto the same key are rejected with HTTP 400 instead of being merged. Elements are compared by namespace and local name, so the same element written with two prefixes bound to the same namespace stays one repeated element. - An element that occurs **once** becomes an object or string, an element that occurs **more than once** becomes a list. Templates using repeating sections (`rr_`) must therefore be built against a payload that really repeats. - Attributes are collected under `_attributes`, mixed text next to child elements under `_text`. - DTD-declared internal entities are resolved; external entities are never loaded. - The top-level key `or` is reserved for Output.Rocks control data. A root element that maps to `or` is rejected with HTTP 400.

POST/api/rendering/xml

Authorizations

X-AUTH-TOKEN
stringheaderrequired

Value for the X-AUTH-TOKEN header parameter.

Query Parameters

template
stringrequired

Template identifier. Maximum 255 characters.

format
stringdefault:pdf

Document format to render.

comment
string

Rendering comment.

webhook
string

Webhook (identifier) to execute after document rendering. Maximum 255 characters.

emailServer
string

Identifier of Email-Server configuration in Output.Rocks. Maximum 255 characters.

externalId
string

External ID for the rendering request, e.g. a correlation ID handed over by the target system. Maximum 255 characters. Available in webhooks as `<<document.externalId>>`.

metadata
string

Optional metadata as a JSON string to be used in webhooks. Output.Rocks adds the reserved key `eInvoiceStandalone` when `xrechnung` or `eInvoiceProfile` is set.

pdfUniversalAccessibility
booleandefault:false

Enable PDF universal accessibility.

xrechnung
booleandefault:false

Produce a standalone e-invoice XML instead of a PDF. Shorthand for `eInvoiceProfile=xrechnung`.

eInvoiceProfile
string

E-invoice profile for the standalone e-invoice output. Setting it enables standalone mode just like `xrechnung=true`.

skipValidation
booleandefault:false

Skip KoSIT validation of the standalone e-invoice. Only evaluated together with `xrechnung` or `eInvoiceProfile`.

Request Body

application/xml
required

Arbitrary well-formed XML payload.

{}
text/xml
required

Arbitrary well-formed XML payload.

{}

Response

201application/json

Rendering resource created