Skip to end of metadata
Go to start of metadata

Introduction

This plugin was created to solve use cases where we need to format the JSON response of a JSON API call in order to store data into a form or workflow variable.

This plugin can be considered as an alternative to the default bundled JSON Tool.

The configurations are exactly similar to the default bundled JSON Tool in Joget, just with an additional optional property to write bean shell script to format/modify the JSON response.

The plugin source codes can be found at JogetOSS Github. Feel free to clone and customize to suit your needs.

Enhanced JSON Tool Properties

To learn how to configure the JSON Tool plugin, do see the KB page for JSON Tool.

This plugin's configuration is identical, only with the additional configurable properties below.

Format Response

NameDescription
Enable Response FormattingWhen checked, you can start writing bean shell script to format the JSON response.
Script

The "Enable Response Formatting" property must be enabled in order to write bean shell script here.

Injected Variables:

  • data - This is a Map object of the JSON response from the JSON API call.

Expected Return Object:

It is expected to return a Map object that would later on be processed as configured to store to form and/or workflow variables.

Example:

Return the response only for the first item in a JSON array with the object name of "apps".

return data.get("apps")[0];

Download Sample App

APP_enhanced_json_tool-sampleApp.jwa

Notes:

  • This sample app already includes the Enhanced JSON Tool plugin. So just import into your Joget server and start using.
  • The API Domain Whitelist / API IP Whitelist setting in General Settings needs to be configured to allow JSON API requests, in order for this sample app to work.




  • No labels