How can we help you?

Advanced documentation search

Template Assignment, Validation, and Compilation API

Product: FeraRender Topic: API Versions: Applies to all documented versions Current
Written by user
Updated

Manage assignments and drive the composite-template lifecycle by API.

Audience: Application developers
Recommended visibility: Public

Overview

Manage assignments and drive the composite-template lifecycle by API. API clients must be tenant-aware, permission-aware, and capable of handling both JSON and binary responses.

Key points

  • GET assignments returns ordered components.
  • PUT assignments replaces the full set.
  • POST scan locates friendly placeholders.
  • POST validate reports unresolved mappings.
  • POST compile generates the compiled package and manifest.
  • GET compilation retrieves current compile details.

Endpoints

Method Route Purpose
GET /api/v1/templates/i/{uuid}/assignments List assignments for a template.
PUT /api/v1/templates/i/{uuid}/assignments Replace the full assignment set.
POST /api/v1/templates/i/{uuid}/scan Find friendly placeholders.
POST /api/v1/templates/i/{uuid}/validate Find unresolved field mappings.
POST /api/v1/templates/i/{uuid}/compile Compile a composite template.
GET /api/v1/templates/i/{uuid}/compilation Read compilation status and manifest.

Recommended procedure

  1. Send authentication and instance headers.
  2. Validate the request body before transmission.
  3. Inspect HTTP status, content type, and structured errors.
  4. Log non-sensitive identifiers needed to reproduce failures.

Client requirements

  • Check the HTTP status before processing the body.
  • Check Content-Type before deciding whether the response is JSON, DOCX, or PDF.
  • Do not log authentication tokens or complete client document data.
  • Preserve the instance context through every Feradel service-to-service call.
  • Treat validation and compilation errors as input or template defects rather than transient network failures.

Troubleshooting

A client treats an error as a file

Check HTTP status and Content-Type before writing the response body to disk.

The same request works in another tenant

Compare instance, owner, token permissions, and object UUIDs.

A route returns an unexpected envelope

The current controllers are not fully standardized; handle HTTP status and documented fields defensively.

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.