Review the data and document formats FeraRender accepts and returns.

Overview

Review the data and document formats FeraRender accepts and returns. Use this article before changing production templates or writing an integration. It establishes the expected workflow and the terms used by the rest of the library.

Key points

• XML is the primary render-time data input.
• JSON is used for API control payloads and dataset definitions.
• DOCX packages use OpenXML parts.
• PDF workflows include generated documents and fillable forms.
• Responses may be binary files or JSON containing base64 data and metadata.

Recommended procedure

1. Confirm that you have the correct instance and permission.
2. Identify the input data and required output format.
3. Use a non-production template and representative sample data for the first test.
4. Record the template UUID, output mode, and any validation result.

Troubleshooting

The result format is wrong

Confirm the workflow and template output setting, then verify any asPdf, metadata, or content-type option.

The template cannot be found

Confirm the instance, owner, UUID or exact name, and whether a global template must first be imported.

The request is unauthorized

Check the token, instance header, and required view, edit, native-XSLT, or render permission.

Related documentation

• FeraRender Access and Permissions
• Render Your First Document
• FeraRender Concepts and Glossary

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.