Introduction

The API Connector can be used with the Form Options Data Store to dynamically populate a form with data from an API.

Get started

API Connector Process Tool plugin

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 Operation, select the operation created in the API Connector Builder.
5. Click Apply Change.

Properties configuration

• API Connector: Select the created API connector.
• Select Operation: Select an operation created in the API Connector Builder. Depending on the operation selected, configure:
  • id: Available with the GET and DELETE methods. Specify the ID of the item to fetch or delete.
  • Payload: Available with the POST and PUT methods. The structure of the API in JSON or YAML format. You can add many more details, like authentication methods, request parameters, query parameters, or more complex schemas.
• Do not execute when no record id?: Displays an empty form when there is no record ID when checked.

• Base JSON Object Name for Multirow Data: Configure the name of the base JSON object (e.g., data).
• Primary Key: Configure the Unique Identifier of the JSON object (e.g., id). Mandatory field.
• Manual Field Mapping: Allows for manual mapping of a field name to a JSON object name if the names are different when checked.
  • Field Mapping:
    • FIELD NAME
    • JSON OBJECT NAME

Related documentation

• Form Options Data Store