Versions Compared

Key

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

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

Note

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

...

.

Image Added


NameDescription
1Form
Panel
borderColorblack
bgColor#fbfff5
borderStylesolid

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

2Short Description
Panel
borderColorblack
bgColor#fbfff5
borderStylesolid

Any description here.

3Ignore Form Permission
Panel
borderColorblack
bgColor#fbfff5
borderStylesolid

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

4

Anchor
Add form data
Add form data
Add form data

Panel
borderColorblack
bgColor#fbfff5
borderStylesolid
Add a new record to the specified form.

Name

Description
URL/form/{formId}
HTTP MethodPOST
Path Parameters
ParameterDescription
formIdForm ID.
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:

Code Block
languagejs
collapsetrue
{
  "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.

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

Anchor
Add form data with file upload
Add form data with file upload
Add form data with file upload

Panel
borderColorblack
bgColor#fbfff5
borderStylesolid
Add a new record to the specified form, with support for file handling.
NameDescription
URL

/form/{formId}/addWithFiles

HTTP MethodPOST 
Path Parameters
ParameterDescription
formIdForm ID.
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.

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

Anchor
Delete form data
Delete form data
Delete form data

Panel
borderColorblack
bgColor#fbfff5
borderStylesolid
Delete a record of the specified form, via record ID.

Name

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

Anchor
Download all uploaded files in zip
Download all uploaded files in zip
Download all uploaded files in zip

Panel
borderColorblack
bgColor#fbfff5
borderStylesolid

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/{formId}/{recordId}/{fieldId}/files
HTTP MethodGET
Path Parameters      
ParameterDescription
formIdForm ID
recordIdForm Record ID
fieldIdUpload Field ID
Sample Response   

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

8

Anchor
Download uploaded file
Download uploaded file
Download uploaded file

Panel
borderColorblack
bgColor#fbfff5
borderStylesolid

Download an uploaded file from a specified form upload field.

Warning

Please ensure that the File Upload > Advanced Options > Permission is set accordingly as this determines who can access the file

NameDescription
URL/form/{formId}/{recordId}/download/{fileName}   
HTTP MethodGET
Path Parameters
ParameterDescription
formIdForm ID
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

Anchor
Get form data by record ID
Get form data by record ID
Get form data by record ID

Panel
borderColorblack
bgColor#fbfff5
borderStylesolid

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

Name

Description
URL/form/{formId}/{recordId}
HTTP MethodGET
Path Parameters
ParameterDescription
formIdForm ID
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
Code Block
languagejs
{
  "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

Anchor
Update form data
Update form data
Update form data

Panel
borderColorblack
bgColor#fbfff5
borderStylesolid
Update a record in the specified form.

Name

Description
URL/form/{formId}
HTTP MethodPUT
Path Parameters
ParameterDescription
formIdForm ID.
Body Parameters

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

Note
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.


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

Anchor
Update form data with file upload
Update form data with file upload
Update form data with file upload

Panel
borderColorblack
bgColor#fbfff5
borderStylesolid

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

NameDescription
URL           /form/{formId}/updateWithFiles
HTTP MethodPOST                                                                                                                                       
Path Parameters
ParameterDescription
formIdForm ID.
Body Parameters

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

Note
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.

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