You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 7 Next »

Definition

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

The options here is based on the current app context.


NameDescription
1Form

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

2Short Description

Any description here.

3

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 selected 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

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

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

Delete form data

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

Get form data by record ID

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

Able to filter or sort the returned results via additional parameters.

6

Update form data

Update a record of the specified form.




  • No labels