Template
Creates a Template.
Creates a Template.
/api/templatesAuthorizations
Value for the X-AUTH-TOKEN header parameter.
Request Body
The new Template resource
{
"id": 12345,
"identifier": "my_template_document",
"description": "Invoice for contract <<contract.number>>",
"comment": "This is a special template",
"fileName": "invoice_<<contract.number>>",
"color": "#083E5D",
"maxPageAmount": 10,
"path": "string",
"xmlContent": "string",
"maxBlockedAmount": 10,
"paused": false,
"customId": "<<contract.number>>",
"legacy": false,
"chartIdentifiers": [
"consumption",
"balance"
],
"validatorIdentifiers": [
"address_validator",
"product_validator"
],
"qrCodeIdentifiers": [
"myqrcode"
],
"emailAttachmentIdentifiers": [
"terms_pdf",
"sepa_mandate"
],
"file": "data:application/docx;base64,UEsDBBQABg...",
"brandLayoutDisabled": false,
"brandLayoutLint": [
"string"
],
"createdBy": "user1@company.com",
"updatedBy": "user1@company.com",
"createdAt": "2024-08-23T00:00:00+00:00",
"updatedAt": "2024-08-23T00:00:00+00:00",
"client": {},
"subClient": {},
"brandIdentifier": "default",
"active": true,
"activeFrom": "2024-01-01",
"versionGroup": "123e4567-e89b-12d3-a456-426614174000",
"versionNumber": 1,
"supersededAt": "2024-08-23T00:00:00+00:00",
"changeSummaryDe": "string",
"changeSummaryEn": "string",
"summaryStatus": "pending",
"groupIdentifier": "my_group",
"groupCondition": "data['contract']['balance'] > 0",
"reviewCondition": "data['contract']['id'] > 1000",
"subClientDefault": false,
"brandLayoutLintCount": 1,
"brandLayoutLintFailed": true,
"subClientId": 3,
"subClientDescription": "Branch Office A",
"subClientColor": "#083E5D"
}Response
Template resource created
Identifier generated by Output.Rocks.
Unique identifier to be used for mappings
Template description / title. <<>>-Syntax can be used for dynamical generation.
Comments and notes
Target file name without extension <<>>-Syntax can be used for dynamical generation.
HTML color code to be used on Dashboard-charts and statistics.
Maximum expected pages amount in rendered documents. Documents with page amount > limit will be marked and displayed on Dashboard.
Normalized OpenXML package content extracted from the uploaded DOCX template.
Maximum amount of accepted errors. Template will be paused in case of reaching this limit
Paused flag. Default: false
Optional value in <<>>-Syntax to be extracted and stored on each rendered document.
Legacy flag. To be used only on systems with activated legacy module. Default: false
Identifier list of charts, used in current template
Identifier list of validators, to be executed on current template
Identifier list of QR-Code definitions, to be used on current template
Identifier list of static PDF attachments appended to rendered PDFs
base64 encoded file
Opt-out from the brand's document layout for this template.
What a brand layout would take away from this template - its own headers, footers or section breaks - recorded when the file is uploaded. Advisory: it never blocks a save.
User, created this entry
User, updated this entry
UTC date time of entry creation
UTC date time of last entry update
Active flag. Default: true
Date to activate the entry. Default: today
Immutable lineage key shared by all versions of this configuration entry.
Monotonic version counter within the version group. Display/audit only, not part of resolution.
Moment from which this version is superseded by a newer version of the same version group. Null while the version is (or is scheduled to become) the current one.
AI generated German summary of the changes introduced by this version.
AI generated English summary of the changes introduced by this version.
Generation status of the AI change summary.
Optional group identifier to be used with group conditions
Group condition.
Review condition.
Default for environmental tenants (sub-clients)
Findings count only, so a list can flag a template without carrying the whole report.
A count cannot express "not checked": an inspection that failed reports zero findings and would read in a list exactly like one that found nothing wrong. These are the templates whose layout impact is unknown, so the list has to be able to tell them apart.
SubClient ID. Provided on instances with enabled sub-client module only.
SubClient description. Provided on instances with enabled sub-client module only.
SubClient display colour. Provided on instances with enabled sub-client module only.