API Connector Form Store plugin

Introduction

The API Connector can be used as a tool to be executed upon executing data submission.

Get started

API Connector Form Store plugin

1. In Form Builder, navigate to the Settings tab.
2. For Save Data To, select API Connector from the drop-down list.
   

Properties configuration

Save Data To (API Connector): Configure API Connector:

• API Connector

  • Select the API connector created.

• Auto populate Request Body Payload data?

  • Automatically fill in the body of an API request with the required data based on predefined rules or configurations.

• Use Different API For Update

  • Allows use of a second API method when checked.

• API Connector for Update

  • Select a different API connector created.

• Handling for Field Workflow Variable?

  • Update the workflow variable on the form field.

  • Not applicable for grid elements.

• Handling for Uploaded Files?

  • Store uploaded files to app_formuploads" based on the form properties table name.
    

Once an API Connector is selected, the API Connector (<API Connector>) section is displayed. These following properties to configure:

• Select Operation

  • Select a PUT or POST operation created in the API Connector Builder.

• Description:
  • Displays a description of the API Connector Builder.
• Payload:
  • Define the structure of the API in JSON or YAML format. Can include details like authentication methods, request parameters, query parameters, or more complex schemas.

Related documentation

• Form Settings