Versions Compared

Key

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

...

  1. Click the form element on the canvas to open the Properties tab.
  2. For Or Load Data Form, select API Connector from the drop-down list.
  3. For API Connector, select the API connector created.
  4. For Select Operationselect the operation created in the API Connector Builder.
  5. Click Apply Change.

Properties Configuration 

API Endpoints

OAS documents come with API 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 Added

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 Added

Parameters:  

  • Name: Name of the GET operation 

...

  • Mode: 
    • Default
    • Force Mandatory
    • Hide Field

PUT

Image Added

Parameters:  

  • Name: Name of the PUT operation 
  • Description: A description of the PUT operation
  • Request Body Input Type: 
    • Payload:
      • Request Body
    • Input FIelds:
      • Field Label
      • Default Value
      • Mode: 
        • Default
        • Force Mandatory
        • Hide Field

SET

Image Added

Parameters: 

  • Name: Name of the SET operation 

...

You can download the API Connector plugin from the Joget Marketplace Joget Marketplace once it is released. 

Download Sample App