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

Compare with Current View Page History

« Previous Version 3 Next »


New Feature

This is a new feature in Joget DX 8.

Introduction

JSON API for Loading to Lists allows one to populate a List using JSON calls.

JSON API Properties

Configure JSON API


NameDescription
JSON URLURL to be called. Mandatory Field.
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. 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.


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.

e.g. 

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