Versions Compared

Old Version 3

changes.mady.by.user Justin

Saved on

compared with

New Version Current

changes.mady.by.user Justin

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Panel
borderColorgreen
borderWidth1
titleBGColor#ddffcc
borderStylesolid
titleDefinition

List API can retrieve list data from the specified datalist.

Note

The options here This API is based on the specified datalist in the current app context.


NameDescription
1List
Panel
borderColorblack
bgColor#fbfff5
borderStylesolid

Select

the datalist

any datalist present in the current app, for interaction with API.

2Short Description
Panel
borderColorblack
bgColor#fbfff5
borderStylesolid

Any description here.

3Retrieve list data
Panel
borderColorblack
bgColor#fbfff5
borderStylesolid

Get all records from the specified datalist.

Name

Description
URL/list/{datalistId}
HTTP MethodGET
Path Parameters
ParameterDescription
datalistIdDatalist ID to get records from.
Query String Parameters
ParameterDescription
filters

Filters the returned datalist records by querying the search terms with the datalist columns.

Similar to the LIKE operator for database querying.

Tip
titleTip

From API Builder plugin BETA4 onwards, here supports Date Range filtering.

Multiple values for the date range filter can be split with the ("|") symbol.

It will look like this:

Code Block
http://localhost:8080/jw/api/list/ExpensesListAll?d-114034-fn_dateCreated=2021-12-25|2021-12-30

Do note that when calling this API externally, special characters must be encoded before performing the API call. So after encoding URL special characters, it should look like this below:

Code Block
http://localhost:8080/jw/api/list/ExpensesListAll?d-114034-fn_dateCreated=2021-12-25%7C2021-12-30
startOffsetStarting position of records to start query. Expects an integer.
pageSizeNumber of results to return. Expects an integer.
Sample Response
Code Block
languagejs
{
  "total": 4,
  "size": 4,
  "data": [
    {
      "ref": "0003",
      "total": "5.00",
      "dateCreated": "Aug 21, 2019",
      "remark": "",
      "title": "Business Trip CEO",
      "claimant": "Admin Admin",
      "SelectApprover": "admin",
      "status": "<span style='color:orange;font-weight:bold;'>Submitted</span>"
    },
	  .....
  ]
}