Versions Compared

Key

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

...

  1. In List Builder, in the DATA tab, for Select Source of Data, select API Connector from the drop-down list.
  2. For API Connector, select the API Connector created.
  3. For Select Operation, select the operation created in API Connector Builder. Depending on the operation type, configure:
    • id
    • Payload
  4. For Base JSON Object Name for Multirow Data, configure the name of the base JSON object (e.g., data).
  5. For Total Record Count JSON Object Name, configure the total number of records in the JSON object (e.g., data.total).
  6. For Primary Key, configure the Unique Identifier of the JSON object (e.g., data.id). Mandatory field.
  7. In the DESIGN tab, drag and drop the API Connector to the list or canvas.
  8. Click the API Connector to configure the following properties:
    • Label: Select a display label.
    • 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
      • Payload
  9. Click Apply Change and click SAVE.

Form Builder 

Settings tab

  1. In Form Builder, navigate to the SETTINGSthe Settings tab. 
  2. Under Advanced, for Post Processing Tool, select API Connector from the drop-down list. 
  3. For API Connector, select the API connector created. 
  4. For Form, select the form to store the data to. 
  5. For Select Operation, select the operation created in the API Connector Builder. 
  6. For Base JSON Object Name for Multirow Data, select the name of the base JSON object (e.g., data).

Form Options Data Store

  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 

...

The API Connector plugin is part of the Addon Builders suite, designed to help you create, manage, and secure custom APIs within your Joget platform. The available API elements cover a wide range of functionality, from managing users to handling forms and processes. 

Download Plugin 

You can download the API Connector plugin from the Joget Marketplace. 

...