Table of Contents
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
- Click the form element on the canvas to open the Properties tab.
- For Or Load Data Form, select API Connector from the drop-down list.
- For API Connector, select the API connector created.
- For Select Operation, select the operation created in the API Connector Builder.
- Click Apply Change.
Properties configuration
Name | Description |
---|---|
API Connector |
...
Select the created API connector. | |
Select Operation |
...
Select an operation created in the API Connector Builder. Depending on the operation selected, configure:
|
...
|
...
| ||
Do not execute when no record id? |
...
Displays an empty form when there is no record ID when checked. |
...
Name | Description |
---|---|
Base JSON Object Name for Multirow Data |
...
Configure the name of the base JSON object (e.g., |
...
name). |
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. |
...
|