Format Form API Response (GET) Plugin

Introduction

This article features the Format Form API Response (GET) Plugin created by Relinns Technologies. The Format Form API Response (GET) plugin is a lightweight enhancement over Joget's official Form API plugin, developed by Relinns Technologies. Its primary purpose is to correct and improve the default GET API response by converting stringified JSON and array fields back into valid JSON objects and arrays. This is essential for clients or integrations expecting properly structured JSON responses.

Prerequisites

• Joget DX 8 or higher
• Administrative access to your Joget installation
• Familiarity with Joget App Designer and Plugin Management

Plugin Information

To download this plugin, visit the Joget Marketplace.

Versioning

• Current Version: 8.0-SNAPSHOT
• Maintained by: Relinns Technologies
• Compatible with: Joget DX 8 or higher

Steps to install

1. Download the plugin Jar File.
2. Log in to Joget as an admin user.
3. Navigate to Settings > Manage Plugins.
4. Click on Upload Plugin and upload the JAR file.
   
5. The plugin will appear as Format Form API Response (GET) under available plugins.
   

Usage

How to Use

1. From the API Builder or your App plugin settings, choose the 'Format Form API Response (GET)' plugin.
   
2. Provide the required `formDefId` (the form definition ID you want to expose).
   
3. Use the endpoint `GET /form/{formDefId}/{recordId}` to retrieve form data.
4. Any field containing stringified JSON (starting with `{}` or `[]`) will be automatically parsed into valid JSON object or array.
   
5. All permission checks, subform inclusions, and flattening options remain supported.
   
   For advanced usage, such as including subform data, applying permission filters, or flattening the result, use the documented query parameters similar to the default Form API plugin.

Credits

This plugin, sample app, and documentation are created by Relinns Technologies.