Type

Specify Allows to specify the type of model, such as:

• API: For integrating with external applications via REST APIs.

• Record: For managing Salesforce & few other CRM object data.

Connection

Allows you to choose the desired REST connection to fetch records from.

Label

Assign a unique name to the model.

Authentication Type

Allows to specify flexible and secure access to integrated applications through following options:

1. Session: Uses active session details for authentication i.e., if a user wants to perform REST operations in self org.

2. Public: Provides access without requiring user credentials i.e., if a user wants to access public APIs such as Google's Weather API.

3. Connection: Authenticates using established REST API connection with external web applications such as accessing Quickbooks.

Connection

Provides the ability to specify the source (i.e., from various web applications to be integrated with REST APIs) to select records .

Note: This field is only visible when Authentication Type is set as Connection.

Image Added

Label

Allows to specify the name of the model.

Name

Provide Allows to provide unique API name for the model.

Execute on Load

Enables records to be fetched automatically upon loading the component.

Request Parameters

Method

Different Allows to specify HTTP method among different HTTP methods such as GET, POST, PATCH, etc. are used to perform specific operations on resources. You can explore more about methods by clicking here.

URLAdd

• Allows to add the relevant URL that corresponds to the connection from which

Headers

• user wishes to perform CRUD.

Record Count

Set the record count to either Multirecord or Single, depending on whether you are dealing with multiple records or a single record in the data operation.

Query Params

It is way to pass information to an API in a flexible and simple manner. They are added to the end of the API endpoint URL as a series of key-value pairs. It can be used for filtering, sorting, pagination, formatting or searching the data.

• User has also accessibility to specify URL dynamically using Merge Text.

Is Array?

Allows to specify whether the data requested from resource should be treated as a single record or multiple records (an array).

Type

Allows to specify type of request query argument which will passed to URL, which is basically of two types:

• Object: Query argument passed to the URL will be JSON body or Object.

• String: Query argument passed to the URL will be a s string.

Request Body

Generate Schema

It can define fields using JSON formatAllows to define object JSON schema which will be passed on to request.

Create New Field

It can create fields using the create field Model.Allows users to create fields that can be utilized to build an object JSON schema.

Note: When a new field is created, it will be automatically mapped in JSON structure of Generate Schema as follows:

Image AddedImage Added

Response Parameters

Status Code

It indicates whether a specific HTTP request has been successfully completed.

New Button

It allows to specify new Status Code as per one's business need.

Record Count

Set the record count to either Multirecord or Single, depending on whether you are dealing with multiple records or a single record in the data operationIs Array?

Allows to specify whether the data retrieved from resource should be treated as a single record or multiple records (an array).

Type

Allows to specify type of response which will retrieved through REST request, which is basically of two types:

• Object: Provides a structured response that includes detailed data such as headers, response codes, and other relevant information

• String: Offers a simpler text-based response.

Response Body

Generate Schema

It can define fields using JSON formatAllows to define object JSON schema which will be retrieved from response.

Create New Field

It can create fields using the create field Model.Allows users to create fields that can be utilized to build an object JSON schema that will be received from response.

Note: When a new field is created, it will be automatically mapped in JSON structure of Generate Schema as follows:

Image AddedImage Added

Array

• It represents a collection of items, where each item can be of the same type or a specified set of types.

• Arrays are useful for storing lists or multiple values under a single field.

Checkbox

• It represents a boolean value, typically used in forms to indicate a true/false or yes/no option.

• This field type is ideal for settings or preferences that can be toggled on or off.

Date

• It stores a date value without time information.

• This type is used when only the date is relevant, such as a birthdate or a specific event date.

Date and Time

• It stores both date and time information.

• This is used when the exact moment of an event is important, such as timestamps for record creation or updates.

Double

• It represents a floating-point number, suitable for storing decimal values or precise measurements.

• This type is ideal for fields that require numeric data with fractions.

Integer

• It represents a whole number without any decimal points.

• This type is used for counting or indexing, such as user IDs, quantity fields, or age.

Object

• It represents a structured data type that can contain multiple named properties, each with its own type.

• Objects are used for more complex data structures, such as nested entities.

Panel
panelIconId 1f5e8 panelIcon :speech_left: panelIconText 🗨️ bgColor #DEEBFF	#F4F5F7
For example,

Text

• It stores plain text, which can be a short string or a longer block of text.

• This field type is used for any data that needs to be expressed in words, such as names, descriptions, or comments.