DocumentRendering

Retrieves a Document Rendering resource.

Returns a Document Rendering resource.

GET/api/document-renderings/{id}

Authorizations

X-AUTH-TOKEN
stringheaderrequired

Value for the X-AUTH-TOKEN header parameter.

Query Parameters

flags[]
string[]

Flags to fetch additional data

Path Parameters

id
stringrequired

DocumentRendering identifier

Response

200application/json

DocumentRendering resource

id
integer

Document Rendering ID generated by Output.Rocks.

Example: 123

format
enum<string>

Target file format

Available options: pdfdocdocxodtrtfhtmltxt

Example: "pdf"

type
enum<string>

Available options: testapiapi_email_attachment

description
string

Target file format

Example: "This is a generated file description."

fileName
string

Target file name

Example: "2024_01_01_invoice.pdf"

billablePages
integer

Amount of billable pages in generated document

Example: 2

documentPages
integer

Example: 0

maxPageViolation
boolean

Available options: truefalse

Example: false

docPath
string | null
metadata
string | null[]
billed
boolean

Available options: truefalse

Example: false

externalId
string

Optional external ID provided by origin application while requesting rendering

Example: "ext-123"

externalState
string | null
customId
string

Value, extracted from received data by expression, configured on template

Example: "INV789"

template
object

Template URI

Example: "/api/templates/123"

brandIdentifier
string | null

What this document was actually rendered with.

brandVersionNumber
integer | null
brandLayoutPath
string | null
renderStartedAt
string<date-time> | null
renderDurationMs
integer | null

Summed over every format this process rendered, so one number answers "how long".

renderData
object

Render Data URI

Example: "/api/render-datas/123"

webhooks
string<iri-reference>[]
emailProcess
value | null
xmlProcess
value | null
renderingRequest
object

Rendering Request URI

Example: "/api/rendering-request/123"

failedDataValidators
string<iri-reference>[]
file
string<binary>

base64 encoded generated file

Example: "data:application/docx;base64,xxx... | data:application/pdf;base64,xxx..."

createdBy
string

User, created this entry

Example: "user1@company.com"

updatedBy
string

User, updated this entry

Example: "user1@company.com"

createdAt
string<date-time>

UTC date time of entry creation

Example: "2024-08-23T00:00:00+00:00"

updatedAt
string<date-time>

UTC date time of last entry update

Example: "2024-08-23T00:00:00+00:00"

client
object
subClient
object
state
string

Workflow state

Example: "done"

workflowLog
string

Workflow logs as a string

Example: "[2024-01-01 00:00:00] Rendering set to blocked because of paused Template"

blocked
boolean

Available options: truefalse

Example: false

wfData
string | null[]
batchAction
string<iri-reference> | null

Example: "https://example.com/"

doneAt
string<date-time> | null
anonymization
string<date-time> | null
anonymized
boolean

Available options: truefalse

Example: false

reviewRequired
boolean

Review required flag.

Available options: truefalse

Example: false

reviewedBy
string

User who requires the review

reviewedAt
string<date-time>

Date when review was required

Example: "2024-01-01T00:00:00Z"

prefix
string
eInvoice
boolean

Whether this document carries a generated ZUGFeRD e-invoice XML.

Available options: truefalse

renderingRequestOrNull
string<iri-reference> | null

Example: "https://example.com/"

subClientId
integer

SubClient ID. Provided on instances with enabled sub-client module only.

Example: 3

subClientDescription
string

SubClient description. Provided on instances with enabled sub-client module only.

Example: "Branch Office A"

subClientColor
string

SubClient display colour. Provided on instances with enabled sub-client module only.

Example: "#083E5D"

webhooksToExecute
boolean

Available options: truefalse

nextWebhookToExecute
string<iri-reference> | null

Example: "https://example.com/"