Joget DX Preview Release Available for Download

Check out Joget DX, the next generation successor to Joget Workflow for faster, simpler digital transformation.

Skip to end of metadata
Go to start of metadata

The JSON Tool enables one to issue a JSON web service call, and to save the returned data into Joget's form data and/or into the process's workflow variable.

Figure 1: JSON Tool Properties - Configure JSON Tool

JSON URLURL to be called.
Call Type
  • GET
  • POST
POST Method
  • POST Parameters
  • POST Parameters as JSON Payload
  • Custom JSON Payload
POST Parameters

When POST Method is set to "POST Parameters", these parameters will be sent as a UrlEncodedFormEntity.

When POST Method is set to "POST Parameters as JSON Payload", these parameters will be sent as a StringEntity in a form of an escaped JSON string.

Custom JSON Payload

Write your own JSON to be the payload. It will be sent as a StringEntity.

This option is available only when "Custom JSON Payload" in selected.

Request HeadersAdd name(s) and value(s) to the request header.
No Response Expected

Check if no response is expected, so that even if there is a response, this tool will simply ignore it.

Using this option will also disable "store to form" and "store to workflow variable" properties.

Debug ModeShow relevant debug entries in the server log for debugging purposes.


Figure 2: JSON Tool Properties - Store to Form

FormTarget form to store data to.
Base JSON Object Name for Multirow DataName of the object that contains an array to be based on.
Field Mapping

Mapping with JSON data with Form fields.

Field NameForm field ID
JSON Object NameJSON property name


Figure 3: JSON Tool Properties - Store to Workflow Variable

Workflow Variable Mapping
Workflow VariableWorkflow Variable Name.
JSON Object NameJSON property name.


In figure 2 and 3, one will need to specify on how to treat the returned data. The returned data may be saved as form data or/add to be saved into process's workflow variable. The example used in this article shows on how one can store multi-row data into a form data table.

Sample JSON API: http://localhost:8080/jw/web/json/apps/published/userviews

Sample JSON Result: 

Figure 4: Sample JSON data saved in Joget form data table

You can download the test app from APP_json1-1-20151026181405.jwa.

Related Tutorials




  • No labels