Form Data API

This page details the Form 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/form/load/(*:appId)/(*:formId)/(*:primaryKeyValue)

Load a specific form record.

• User Role: Admin
• Method: HTTP GET/POST
• Parameters: 
  • appId - App definition ID
  • formId - Form definition ID 
  • primaryKeyValue - The primary key value for the form record
  • includeSubformData - Optional, set to true to recursively include subform data
  • includeReferenceElements - Optional, set to true to include data from reference elements e.g. selectbox, etc.
  • flatten - Optional, set to true to flatten data into a one level key-value map
• Sample URL: http://localhost:8080/jw/web/json/data/form/load/crm/crm_account/001
• Sample cURL Request:

curl -v -d "j_username=admin&j_password=admin" "http://localhost:8080/jw/web/json/data/form/load/crm/crm_account/001?includeSubformData=true&includeReferenceElements=true&flatten=true"

• Sample Response:

{
    "country": "",
    "dateCreated": "27-07-2015 04:26 AM",
    "address": "",
    "accountName": "001",
    "city": "",
    "dateModified": "20-10-2016 04:36 AM",
    "id": "001",
    "state": ""
}

web/json/data/form/store/(*:appId)/(*:formId)/(*:primaryKeyValue)

Create or update a form record.

• User Role: Admin
• Method: HTTP POST
• Parameters: 
  • appId - App definition ID
  • formId - Form definition ID 
  • primaryKeyValue - The primary key value for the form record
• Sample URL: http://localhost:8080/jw/web/json/data/form/store/crm/crm_account/001
• Sample cURL Request:

curl -v -X POST -d "j_username=admin&j_password=admin&accountName=001%Updated&address=001%20Address" http://localhost:8080/jw/web/json/data/form/store/crm//crm_account/001

• or:

curl -v --header "Authorization: Basic YWRtaW46YWRtaW4=" -F "accountName=001 Updated" -F "address=001 Address" http://localhost:8080/jw/web/json/data/form/store/crm//crm_account/001

• Sample Response:

{
    "id": "001"
}

web/json/data/form/delete/(*:appId)/(*:formId)/(*:primaryKeyValue)

Delete an existing form record.

• User Role: Admin
• Method
  HTTP POST
• Parameters
  • appId - App definition ID
  • formId - Form definition ID 
  • primaryKeyValue - The primary key value for the form record
• Sample URL: http://localhost:8080/jw/web/json/data/form/delete/crm/crm_account/001
• Sample cURL Request:

curl -v -X POST -d "j_username=admin&j_password=admin" http://localhost:8080/jw/web/json/data/form/delete/crm//crm_account/001

• Sample Response:

{
    "id": "001"
}