API

Config

Config Field	Description

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. Note: By default, Model is chosen as Source API Type. For now, we use API Models created in layout as Source API Type.
Model	It defines the API model associated with the Source API Type chosen. Note: This option is only visible, if one chooses Source API Type as Model.
Authorization Type	It specifies the type of authorization required for the API. Note: This option is only visible, if one chooses Source API Type as URL.
Relative URL	It indicates the relative URL path for the API endpoint.
Method	It defines the HTTP method (e.g., GET, POST) used for the API request.
Is Request Array	If checked, it indicates whether the request is an array of objects.
Query Params	It lists the query parameters included in the API request.
Request Body	It contains the data sent in the body of the API request.
Responses	It defines the expected responses from the API.

Params Field	Description

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.

Params Field	Description

Params Field	Description
Label	A user-friendly name for the request body, used for easy identification within the application.
Name	The unique identifier for the request body, 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 request body becomes mandatory.
Is Array ?	It specifies if the request body can accept multiple values.
Default Value	It sets the default value for the request body, if none is provided.

Response Field	Description

Response Field	Description
Code	It indicates the status code returned by the API.
Is Response Array ?	It specifies whether the response consists of an array of objects.
Response Body	It contains the data returned in the response. Response body modal is same as request body modal, you can explore here, just rephrase request as response in the modal.