Page History

...

1. An OAS document from an API service provider. 
2. Joget DX 8 Enterprise Edition.

How to

...

install

1. Download the plugin JAR file from the Joget Marketplace. 
2. Go to Settings > Manage Plugins > Upload Plugin. 
3. Once uploaded, the plugin will be available in your Joget environment.

...

1. In Form Builder, navigate to the Settings tab. 
2. Under Advanced, for Post Processing Tool, select API Connector from the drop-down list. 
3. For API Connector, select the API connector created. 
4. For Form, select the form to store the data to. 
5. For Select Operation, select the operation created in the API Connector Builder. 
6. For Base JSON Object Name for Multirow Data, select the name of the base JSON object (e.g., data).

API Connector Form Options Store plugin

API Connector Form Options plugin

...

OAS documents come with API Endpoints endpoints that can be comprised of either the POST, GET, PUT and DELETE HTTP methods. The following image shows a sample of API endpoints included in an allowance template OAS document.

Image Modified

POST

Image Modified

Parameters:  

• Name: Name of the POST API endpoint.

...

• Request Body Input Type: 
  • Payload:  
    • Request Body 
  • Input FIelds: 
    • Field Label
    • Default Value
    • Mode
      • Default 
      • Force Mandatory 
      • Hide Field

GET

Image Modified

Parameters:  

• Name: Name of the GET operationGET API endpoint. 

• Description: A description of the GET operationGET API endpoint.

• Field Label: Specify a field label.

...

• Mode: 
  • Default
  • Force Mandatory
  • Hide Field

PUT

Image Modified

Parameters:  

• Name: Name of the PUT operationPUT API endpoint.
• Description: A description of the PUT operationAPI endpoint.
• Request Body Input Type: 
  • Payload:
    • Request Body
  • Input FIelds:
    • Field Label
    • Default Value
    • Mode: 
      • Default
      • Force Mandatory
      • Hide Field

SET

Image Modified

Parameters: 

• Name: Name of the SET operationSET API endpoint.

• Description: A description of the SET operationSET API endpoint.

• Field Label: Specify Specify a field label.

• Default Value: Specify a default value.

...