Joget DX Available for Download

Check out Joget DX, the next generation successor to Joget Workflow for faster, simpler digital transformation.

Skip to end of metadata
Go to start of metadata
Definition

Form API can interact with form data of the specified form.

This API is based on the specified form in the current app context.


NameDescription
1Form

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

2Short Description

Any description here.

3Ignore Form Permission

Check this option to ignore form & form section permission for current user when storing/retrieving form data.

4

Add form data

Add a new record to the specified form.

Name

Description
URL/form/*yourFormId*
HTTP MethodPOST
Body Parameters

The parameters required here is highly dependent on the form data schema of the specified form.

For example, for "Expense Claim Form" in Expenses Claim app found in most default Joget installations, it may look like this:

{
  "id": "string",
  "sfD": {
    "ref": "string",
    "title": "string",
    "remark": "string",
    "SelectApprover": "string",
    "claimant": "string",
    "username": "string",
    "status": "string",
    "id": "string"
  },
  "spECD": [
    {
      "id": "string",
      "category": "string",
      "date": "string",
      "purpose": "string",
      "amount": "string"
    }
  ],
  "total": "string",
  "receipt": "string",
  "CreatedDate": "string",
  "dateCreated": "2019-08-28",
  "dateModified": "2019-08-28",
  "createdBy": "string",
  "createdByName": "string",
  "modifiedBy": "string",
  "modifiedByName": "string"
}
Sample Response

The record ID will be returned as the success response.

If no record ID is specified, a uniquely generated UUID will be created.

{
  "id": "d6cc05e4-c0a86310-60e35ca0-9dd035a0",
  "errors": {}
}
5

Add form data with file upload

Add a new record to the specified form, with support for file handling.
NameDescription
URL

/form/*yourFormId*/addWithFiles

HTTP MethodPOST 
Body Parameters

The parameters required here is highly dependent on the form data schema of the specified form.

Sample Response

The record ID will be returned as the success response.

If no record ID is specified, a uniquely generated UUID will be created.

{
  "id": "cd0f9c53-1e08-437f-868a-c8a76a9fad7f",
  "errors": {}
}
6

Delete form data

Delete a record of the specified form, via record ID.

Name

Description
URL/form/*yourFormId*/{recordId}
HTTP MethodDELETE
Path Parameters
ParameterDescription
recordIdForm record ID.
Sample Response
{
  "date": "Wed Aug 28 14:07:37 SGT 2019",
  "code": "200",
  "message": "Successful operation"
}
7

Download all uploaded files in zip

Download all uploaded files from a specified form upload field, compressed into a zip file.

Commonly used for form upload fields that support multiple file uploads.

NameDescription
URL/form/*yourFormId*/{recordId}/{fieldId}/files
HTTP MethodGET
Path Parameters      
ParameterDescription
recordIdForm Record ID
fieldIdUpload Field ID
Sample Response   

All files found will be bundled and downloaded as a zip file. 

8

Download uploaded file

Download an uploaded file from a specified form upload field.

NameDescription
URL/form/*yourFormId*/{recordId}/download/{fileName}   
HTTP MethodGET
Path Parameters
ParameterDescription
recordIdForm Record ID
fileNameFile name to be download
Query String Parameters
ParameterDescription
attachment

Option to set the file as attachment.

Expects a boolean value.

Sample Response

The file will be downloaded.

9

Get form data by record ID

Retrieve data of a record from the specified form, via record ID.

Name

Description
URL/form/*yourFormId*/{recordId}
HTTP MethodGET
Path Parameters
ParameterDescription
recordIdForm record ID.
Query String Parameters
ParameterDescription
includeSubformDataInclude all subform(s) data present in the specified form, into the response.
includeReferenceElements

Include all referenced elements present in the specified form, into the response.

(e.g: select box element referencing a datalist record)

flattenDataOption to flatten all JSON objects to a single-level key-value map.
Sample Response
{
  "createdByName": "Admin Admin",
  "dateModified": "2019-08-15 15:43:35.0",
  "remark": "",
  "title": "Spend everything",
  "SelectApprover": "admin",
  "ref": "0001",
  "total": "0.00",
  "modifiedByName": "Admin Admin",
  "dateCreated": "2019-04-25 20:14:28.0",
  "createdBy": "admin",
  "CreatedDate": "2019-08-15",
  "modifiedBy": "admin",
  "receipt": "",
  "id": "44_expenseclaim_process1",
  "claimant": "Admin Admin",
  "status": "Submitted",
  "username": "admin"
}
10

Update form data

Update a record in the specified form.

Name

Description
URL/form/*yourFormId*
HTTP MethodPUT
Body Parameters

The parameters required here is highly dependent on the form data schema of the specified form.

The record ID specified must be of an existing record of the form, to update its records successfully.
Sample Response

The record ID will be returned as the success response.

{
  "id": "d6cc05e4-c0a86310-60e35ca0-9dd035a0",
  "errors": {}
}
11

Update form data with file upload

Update a record in the specified form, with support for file handling.

NameDescription
URL           /form/*yourFormId*/updateWithFiles
HTTP MethodPOST                                                                                                                                       
Body Parameters

The parameters required here is highly dependent on the form data schema of the specified form.

The record ID specified must be of an existing record of the form, to update its records successfully.
Sample Response

The record ID will be returned as the success response.

{
  "id": "d6cc05e4-c0a86310-60e35ca0-9dd035a0",
  "errors": {}
}




  • No labels