Introduction

The API Connector Form Load plugin allows loading from an API using the GET method.

Get started

API Connector Form Load plugin

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

Properties configuration

Load Data From (API Connector): Configure API Connector:


NameDescription
API ConnectorSelect the API connector created.
Do not execute when no record id?Checking this option displays a blank form when there are no records.
Select OperationSelect a GET operation created in the API Connector Builder.

NameDescription
Base JSON Object Name for Multirow Data
  • Select the name of the base JSON object (e.g., name).
Primary KeySelect a primary key.
Manual Field Mapping
  • If checked, you can manually map fields if the field name and JSON object name do not match.
    • Field Mapping:
      • FIELD NAME
      • JSON OBJECT NAME
Handling for Field Workflow Variable?Update workflow variable on form field. Not applicable for grid elements.
Handling for Uploaded Files?Store uploaded files to "app_formuploads" based on form properties table name.

Related documentation

  • No labels