Versions Compared

Old Version 4

changes.mady.by.user Mohamed Elorbany

Saved on

compared with

New Version 5

changes.mady.by.user Imran Uzair

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

JSON API Properties

Configure JSON API

Figure 1: Configure JSON API


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


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. 

Code Block
languagexml
firstline1
titleJSON Sample Response
linenumberstrue
collapsetrue
{
    "data":{
        "id": "G-001",
        "description": "",
        "name": "Managers",
        "organization.name": ""
    }
}


Download Demo App

Image Added

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