New Feature

This is a new feature in Joget DX 8.


Introduction

JSON API allows one to populate selections from JSON calls to form elements that make use of the Form Options Data Store.

JSON API Properties

Configure JSON API


NameDescription
JSON URLURL to be called.
Call Type
  • GET
  • POST
  • PUT
  • DELETE
Request Headers

Add name(s) and value(s) to the request header

FieldDescription
NameName (or Type ) of the Request Header 
ValueLink or Value of the Request Header

Body Type

(Only Applicable to Call type = POST or PUT)

Select the POST or PUT method:

  • Request Parameters

    • Add name(s) and value(s) to the request header

      FieldDescription
      NameName (or Type ) of the Request Header 
      ValueLink or Value of the Request Header
  • POST Parameters as JSON Payload

    • 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" is selected.

Passover Current Request CookiesWhen checked, Current Request Cookies will be passed to the server with the request.
Base JSON Object Name for Multirow DataName of the base JSON object (e.g. response).
ID Column

ID value from the specified JSON URL to set as the option value. (e.g. response.id).


Label Column

Label value from the specified JSON URL to set as option label. (e.g. response.value)


Grouping Column

Grouping value from the specified JSON URL to set as option grouping value. (e.g. response.value)


Use AJAX for cascade options?

When checked, this allows these fields to dynamically load available options based on the other field value (grouping column) when dealing with a tremendous amount of selections. Read more at Ajax Cascading Drop-Down List.

Not applicable to Form Data Store. Only available when used as an Options Data Store.

Add Empty OptionEmpty option label. Only in use when Add Empty Option is checked.
Don't trigger empty dependency value

Ensures that the dependent field's actions or changes are only initiated when the controlling field has a valid selected value. 

When the controlling field value is empty, the JSON URL will not be called or triggered to the form.

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

Form Options Caching

NameDescription
Sync Cache Interval

How often to activate cache synchronization (in seconds).

For example, when set to 180 seconds, background synchronization in the server will take place every 180 seconds to refresh with the new/latest data.

Pause sync after idle

How long to wait to pause synchronization after idle.


Download Sample App

  • No labels