How can we help you?

Template Object Reference

Product: FeraRender Topic: Reference Versions: Applies to all documented versions Current

Reference every field stored on a FeraRender template.

Audience: Template authors and developers
Recommended visibility: Public

Overview

Reference every field stored on a FeraRender template. Use this article as a field and behavior reference. Verify release-specific values against the current service before publishing exact versions or product limits.

Key points

  • Core identity fields are uuid, ownerUuid, category, name, caption, and fileName.
  • output and content control rendering.
  • mode identifies FULL or COMPOSITE.
  • datasetUuid, basePackageUuid, and bodyComponentUuid connect composite inputs.
  • compileStatus, checksum, timestamps, compiler version, and validation describe compiled state.

Fields

Field Type or value Purpose
uuid UUID Primary key.
ownerUuid UUID Tenant owner.
category string(10) Template category.
name string(60) Owner-unique name.
caption string(50) Display caption.
fileName string(500) Optional file-name metadata.
meta long text Extensible metadata.
output string(3) Output code.
content long text Template content.
mode string(16) FULL or COMPOSITE.
datasetUuid UUID Dataset reference.
basePackageUuid UUID Base package reference.
bodyComponentUuid UUID Body reference.
compileStatus string(24) Compilation lifecycle state.
compiledChecksum string(64) Compiled checksum.
compiledAt datetime Compile timestamp.
compilerVersion string(64) Compiler version.
validationJson long text Validation details.

Recommended procedure

  1. Locate the relevant object, status, permission, or code.
  2. Confirm tenant and version context.
  3. Apply the documented rule consistently.
  4. Escalate conflicts between this reference and current API behavior for documentation review.

Troubleshooting

The documented value differs from a response

Record the service version and route, then update the draft or implementation before publication.

A field appears unused

Check legacy routes, UI clients, imports, and migration code before removing it.

A status persists unexpectedly

Inspect validationJson, compiled resources, assignments, and recent source changes.

Related documentation


Documentation source: feradelinc/feradel.render.api, reviewed against repository revision b2c3a710. Verify behavior against the deployed release before publishing exact routes, limits, or version requirements.