Font Size:

API Connector List Data plugin

Introduction

The API Connector List Data Plugin allows you to select an API connector as a data source and allows List Builder to create a list of records.

Uses the API Connector as a data source to retrieve the API data.

In List Builder, in the DATA tab, for Select Source of Data, select API Connector from the drop-down list.

API Connector: Select the API connector created.
Select Operation: Select the operation created in the API Connector Builder.
Operation Type Configuration:
- id:
  - Available with GET and DELETE methods.
  - Specify the ID of the item to fetch or delete.
- Payload:
  - Available with POST and PUT methods. Structure in JSON or YAML format. Can include options like authentication methods, request parameters, query parameters, or more complex schemas.
Base JSON Object Name: Configure the name of the base JSON object (e.g., name).
Total Record Count JSON Object Name: Configure the total number of records in the JSON object (e.g., category.id).
Primary Key: Configure the unique identifier of the JSON object (e.g., id). This is a mandatory field.
Auto Handling Full Results Paging & Sorting: Optionally, check this option if you want to retrieve all the records. The paging and sizing will be handled by Joget DX.