You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 9 Next »


New Feature

This is a new feature in Joget DX 8.

Introduction

JSON API List Data Store allows one to populate a List using JSON calls.

JSON API Properties

Configure JSON API

Figure 1: Configure JSON API


NameDescription
JSON URL

URL to be called. Mandatory Field. 

//You may also insert the following URL parameters with its parameters to enable pagination
https://example.com/api/data?pageSize={size}&startOffset={start}
  • pageSize={size}: This parameter is intended to specify the number of items (data entries) to be returned in a single page or response. The actual value for {size} would be replaced with a numerical value indicating the desired page size.
  • startOffset={start}: This parameter is intended to specify the starting offset or index from where the data should be retrieved. The actual value for {start} would be replaced with a numerical value indicating the starting point for fetching data.


Call Type
  • GET
  • POST
  • PUT
  • DELETE

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
  • Request 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.

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
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. data).
Total Record Count JSON Object NameTotal number of records in the JSON object (e.g. data.total)
Primary Key

Unique Identifier of the JSON object (e.g. data.id). Mandatory Field.


Auto Handling Full Results Paging & Sorting

When checked, This option enables automatic sorting for the results returned through the JSON URL.

Uncheck this, if you are performing pagination.


Debug ModeShow relevant debug entries in the server log for debugging purposes.
Sample Response (for Retrieve Columns)

Enter a Sample Response of how the JSON object is formatted.

Must insert a sample response into the field if you are performing pagination.

e.g. 

JSON Sample Response 
{
    "data":{
        "id": "G-001",
        "description": "",
        "name": "Managers",
        "organization.name": ""
    }
}


Download Demo App

Figure 2: Download the demo app below to view how JSON API is used to populate a list.


  • No labels