SPA Templates

SPA: Updates a Template.

SPA: Updates a Template.

PATCH/api/spa/templates/{id}

Authorizations

X-AUTH-TOKEN
stringheaderrequired

Value for the X-AUTH-TOKEN header parameter.

Path Parameters

id
stringrequired

SpaTemplate identifier

Request Body

application/json
required

The updated SpaTemplate resource

{
  "identifier": "my_template_document",
  "description": "Invoice for contract <<contract.number>>",
  "comment": "This is a special template",
  "fileName": "invoice_<<contract.number>>",
  "color": "#083E5D",
  "maxPageAmount": 10,
  "maxBlockedAmount": 10,
  "paused": false,
  "customId": "<<contract.number>>",
  "legacy": false,
  "chartIdentifiers": [
    "consumption",
    "balance"
  ],
  "validatorIdentifiers": [
    "address_validator",
    "product_validator"
  ],
  "qrCodeIdentifiers": [
    "myqrcode"
  ],
  "file": "data:application/docx;base64,UEsDBBQABg...",
  "subClient": {},
  "brandIdentifier": "default",
  "active": true,
  "activeFrom": "2024-01-01",
  "groupIdentifier": "my_group",
  "groupCondition": "data['contract']['balance'] > 0",
  "reviewCondition": "data['contract']['id'] > 1000",
  "subClientDefault": false
}

Response

200application/json

SpaTemplate resource updated

id
integer

Identifier generated by Output.Rocks.

Example: 12345

identifier
stringrequired

Unique identifier to be used for mappings

Example: "my_template_document"

description
string

Template description / title. <<>>-Syntax can be used for dynamical generation.

Example: "Invoice for contract <<contract.number>>"

comment
string

Comments and notes

Example: "This is a special template"

fileName
string

Target file name without extension <<>>-Syntax can be used for dynamical generation.

Example: "invoice_<<contract.number>>"

color
string

HTML color code to be used on Dashboard-charts and statistics.

Example: "#083E5D"

maxPageAmount
integer

Maximum expected pages amount in rendered documents. Documents with page amount > limit will be marked and displayed on Dashboard.

Example: 10

xmlContent
string | null

Normalized OpenXML package content extracted from the uploaded DOCX template.

maxBlockedAmount
integer

Maximum amount of accepted errors. Template will be paused in case of reaching this limit

Example: 10

paused
boolean

Paused flag. Default: false

Available options: truefalse

Example: false

customId
string

Optional value in <<>>-Syntax to be extracted and stored on each rendered document.

Example: "<<contract.number>>"

legacy
boolean

Legacy flag. To be used only on systems with activated legacy module. Default: false

Available options: truefalse

Example: false

chartIdentifiers
string[]

Identifier list of charts, used in current template

Example: ["consumption","balance"]

validatorIdentifiers
string[]

Identifier list of validators, to be executed on current template

Example: ["address_validator","product_validator"]

qrCodeIdentifiers
string[]

Identifier list of QR-Code definitions, to be used on current template

Example: ["myqrcode"]

file
string<binary>

base64 encoded file

Example: "data:application/docx;base64,UEsDBBQABg..."

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"

brandIdentifier
stringrequired

Example: "default"

active
boolean

Active flag. Default: true

Available options: truefalse

Example: true

activeFrom
string<date-time>

Date to activate the entry. Default: today

Example: "2024-01-01"

groupIdentifier
string

Optional group identifier to be used with group conditions

Example: "my_group"

groupCondition
string

Group condition.

Example: "data['contract']['balance'] > 0"

reviewCondition
string

Review condition.

Example: "data['contract']['id'] > 1000"

subClientDefault
boolean

Default for environmental tenants (sub-clients)

Available options: truefalse

Example: false

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"