RenderingRequest

Retrieves a RenderingRequest resource.

Returns a RenderingRequest. Rendering Requests are generated in first process step, represents received data and are handled asynchronously.

GET/api/rendering-requests/{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

RenderingRequest identifier

Response

200application/json

RenderingRequest resource

resolutionOverride
value | null
id
integer

RenderingRequest ID generated by Output.Rocks.

Example: 12345

externalId
string

Optional external ID provided by origin application

Example: "ext-123"

templateIdentifier
string

Template identifier provided in request

Example: "my-template"

format
enum<string>

Document format to be used for rendered documents

Available options: pdfdocodtrtfhtmltxt

Example: "pdf"

webhookIdentifier
string

Webhook identifier provided in request

Example: "my-webhook"

mailServerIdentifier
string

Mail-Server identifier provided in request

Example: "my-webhook"

brandIdentifier
string

Brand identifier resolved by the rendering workflow

Example: "default"

metadata
object

Optional metadata to be used in webhooks

Example: {"reference":"my-reference-123","info":{"version":3,"type":"my-type"}}

staticAttachments
object[] | null
cockpit
boolean

Available options: truefalse

Example: false

renderData
object
comment
string

Comment for the rendering request

Example: "Here is my comment"

origin
string

Rendering Request Origin (api / data collector)

Example: "api"

emailProcesses
object[]
documentRenderings
string<iri-reference>[]
xmlProcesses
object[]
dataCollectorProcess
string<iri-reference> | null

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

import
string
externalState
string
state
string

Workflow state of the request:<br> <b>start</b> - Rendering request created<br> <b>mapped</b> - Rendering request is mapped. Document & Email renderings (if any) are created.<br> <b>done</b> - Rendering request is completely handled<br> <b>anonymized</b> - Rendering request is anonymized (data is deleted)<br>

Example: "done"

client
object
subClient
object
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"

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

blockedMemberWithoutAnonymizationDate
boolean

Blocked-tree rule (OR-132): true while this request or any of its processes is kept blocked, meaning blocked without an anonymization date - what the retention "never" produces. The data of such a tree must stay complete for a retry, so none of its members may be anonymized. A blocked member that carries a date is on the legacy numeric retention and does not hold the others back. $except is the member asking for itself; ExecuteStatemachineHandler has already unblocked it for the transition it is about to apply, and a row's own date governs it anyway. Twins: Repository\Anonymization\BlockedTreeGate (DQL) and AbstractBulkAnonymizer::blockedTreeSql() (bulk).

Available options: truefalse

decodedStaticAttachments
object[]
resolutionDateTime
string<date-time>

Moment used to resolve versioned configuration (templates, brands, webhooks, components, charts, ...) for this request: the persisted retry override when one was chosen, otherwise the original creation time.

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"