...
Figure 1: Configure JSON API
| Name | Description |
|---|
| JSON URL | URL to be called. Mandatory Field. | Code Block |
|---|
//You may also insert the following URL parameters with its parameters to enable pagination
https://example.com/api/data?pageSize={size}&startOffset={start} |
| Info |
|---|
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 | |
Body Type (Only Applicable to Call type = POST or PUT) | Select the POST or PUT method: - Request Parameters
- 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.
|
| Request Headers | Add name(s) and value(s) to the request header | Field | Description |
|---|
| Name | Name (or Type ) of the Request Header | | Value | Link or Value of the Request Header |
|
| Passover Current Request Cookies | When checked, Current Request Cookies will be passed to the server with the request. |
| Base JSON Object Name for Multirow Data | Name of the base JSON object (e.g. data). |
| Total Record Count JSON Object Name | Total 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. | Warning |
|---|
Uncheck this, if you are performing pagination. |
|
| Debug Mode | Show 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. | Warning |
|---|
Must insert a sample response into the field if you are performing pagination. |
e.g. | Code Block |
|---|
| language | xml |
|---|
| firstline | 1 |
|---|
| title | JSON Sample Response |
|---|
| linenumbers | true |
|---|
| collapse | true |
|---|
| {
"data":{
"id": "G-001",
"description": "",
"name": "Managers",
"organization.name": ""
}
} |
|
...