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.

Get started

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

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: 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.
     
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., id). Mandatory field.
7. Optionally, check the Auto Handling Full Results Paging & Sorting option if you retrieve all the records. The paging and sizing will be handled by Joget DX.
   
   

Related documentation

• List Data Store