Joget DX Available for Download

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

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Note

The options here is based on the current app context.


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

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/*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:

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

A uniquely generated form record ID will be returned as the success response.

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.
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. A uniquely generated form record ID will be returned as the success response.

Sample Response

A uniquely generated form record ID will be returned as the success response.

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/*yourFormId*/{recordId}
HTTP MethodDELETE
Path Parameters
ParameterDescription
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 file in zip by record id & field id

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

Anchor
Download uploaded file
Download uploaded file
Download uploaded file

Panel
borderColorblack
bgColor#fbfff5
borderStylesolid

Download uploaded file by record id & file name

NameDescription
URL/form/*yourFormId*/{recordId}/download/{fileName}   
HTTP MethodGET
Path Parameters
ParameterDescription
recordIdForm record ID
fileNameFile name to be download
Query String Parameters
ParameterDescription
attachmentSet the file as attachment
Sample Response

A link will appear for you to download the file that you have specified


Code Block
languagejs
 cache-control: private, max-age=3600 
 connection: keep-alive 
 content-disposition: attachment; filename=img.png; filename*=UTF-8''img.png 
 content-type: image/png;charset=UTF-8 
 date: Wed, 01 Jul 2020 04:09:41 GMT 
 expires: Wed, 01 Jul 2020 05:09:41 GMT 
 keep-alive: timeout=20 
 transfer-encoding: chunked 
 x-content-type-options: nosniff 



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/*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
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 of 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 same form record ID as specified in the body parameters 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 of the specified form.

NameDescription
URL
URL           /form/*yourFormId*/updateWithFiles
HTTP Method
POST
POST                                                                                                                                       
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.

The same form record ID as specified in the body parameters will be returned as the success response.

Sample Response

The same form record ID as specified in the body parameters will be returned as the success response.


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