Versions Compared

Version Old Version 3 New Version Current
Changes made by

Content Writers

Content Writers

Saved on

Key

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

...

Note:

  • By default, Model is chosen as Source API Type.

  • For now, we use API Models created in layout as Source API Type.

Note: This option is only visible, if one chooses Source API Type as Model.

Note: This option is only visible, if one chooses Source API Type as URL.

Note: This option is only visible, if one chooses Source API Type as URL.

Config Field

Description

Source API Type

It specifies the type of API being used as the source to query records.

Source API Type is of 2 types namely: Model and URL.

Info

Model

It defines the API model associated with the Source API Type chosen.

Info

Authorization Type

It specifies the type of authorization required for the API.

Info

Relative URL

It indicates the relative URL path for the API endpoint.

info

Note: This option is only visible, if one chooses Source API Type as URL.

Method

It defines the HTTP method (e.g., GET, POST) used for the API request.

info

Note: This option is only visible, if one chooses Source API Type as URL.

Is Request Array

If checked, it indicates whether the request is an array of objects.

Info

Query Params

It lists the query parameters included in the API request.

Info

Reference: Query Params

Info

Note: This option is only visible, if one chooses Source API Type as URL.

Request Body

It contains the data sent in the body of the API request.

Info

Reference: Request Body

Info

Note: This option is only visible, if one chooses Source API Type as URL.

Responses

It defines the expected responses from the API.

info
Info

Reference: Responses

Note: This option is only visible, if one chooses Source API Type as URL.

Query Params

...

Params Field

Description

Label

A user-friendly name for the query params, used for easy identification within the application.

Name

The unique identifier for the query params, typically used in code or within merge text.

Field Type

It defines the type of input (e.g., text, number) for the parameter.

Required

If checked, the parameter becomes mandatory.

Is Array ?

It specifies if the parameter can accept multiple values.

Default Value

It sets the default value for the parameter, if none is provided.

...