List Data API

This page details the List Data API endpoints and the actions they support. It provides sample URLs and results for quick reference, along with further instructions on how to use each endpoint.

web/json/data/list/(*:appId)/(*:listId)

Load records from a specific datalist.

  • User Role: Admin
  • Method: HTTP GET/POST
  • Parameters: 
    • appId - App definition ID
    • listId - Datalist definition ID
    • start - Optional start index (begins at 0)
    • rows - Optional number of rows to return
    • URL Request Parameter - Optional filters (e.g. d-5043735-fn_accountName)
  • Sample URL: http://localhost:8080/jw/web/json/data/list/crm/crm_account_list
  • Sample cURL Request:
curl -v -d "j_username=admin&j_password=admin" http://localhost:8080/jw/web/json/data/list/crm/crm_account_list?start=0&rows=20&d-5043735-fn_accountName=00
  • Sample Response:

Important Note

The returned attribute "total" will give the total number of records regardless of the filters applied unless the attribute "Consider filter value when get total size?" is checked in the datalist.

{
    "total": 5,
    "data": [{
        "country": "",
        "accountName": "001 Updated",
        "id": "001",
        "state": ""
    }, {
        "country": "",
        "accountName": "002",
        "id": "002",
        "state": ""
    }, {
        "country": "",
        "accountName": "003",
        "id": "003",
        "state": ""
    }]
}
 
Created by Damian Last modified by Aadrian on Dec 13, 2024