Versions Compared

Old Version 6

changes.mady.by.user Debanraj Ravindran

Saved on

compared with

New Version 7

changes.mady.by.user Debanraj Ravindran

Saved on

Key

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

Table of Contents

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.

Properties configuration

  • API Connector: Select the API connector created.

...

  • Base JSON Object Name for Multirow Data: 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). Mandatory field.
  • 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