Versions Compared

Old Version 10

changes.mady.by.user Debanraj Ravindran

Saved on

compared with

New Version 11

changes.mady.by.user Debanraj Ravindran

Saved on

Key

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

...

Once an API connector is created, it can now be used in the included List Builder, Form Builder and and Form plugins as data sources.

List Builder

API Connector List Data plugin

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
    • 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. 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.

API Connector List Action plugin

To call where to perform role?(video 1 minute 4:15) or list actions

  1. In the Design tabIn the DESIGN tab, drag and drop the API Connector to the list or canvas.
  2. 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
  3. Click Apply Change and click SAVE.

...

  1. In Form Builder, navigate to the 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).

API Connector Form Options plugin

API Connector Form Options plugin

...