Type

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.

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.

Open

Visibility of Connection Field

Label

Allows to specify the name of the model.

Name

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

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.

URL

• Allows to add the relevant URL that corresponds to the connection from which user wishes to perform CRUD.

• 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

Allows to define object JSON schema which will be passed on to request.

Create New Field

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:

Open

Manually Created Field

Open

Created Field mapped in JSON Schema

Response Parameters

Status Code

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

Is 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

Allows to define object JSON schema which will be retrieved from response.

Create New Field

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:

Open

Manually Created Field

Open

Created Field mapped in JSON Schema

Cancel

It allows the user to exit the "Generate Schema" process. If any changes were made in the modal, they will be discarded, and no new schema will be generated.

Recreate

It is used to reset the schema creation form within the modal. All fields will be cleared or set to their default values, enabling the user to begin the process of defining a new schema from scratch.

Merge

It allows the user to merge the newly generated schema with an existing schema. This is useful when the user wants to integrate new schema elements into a pre-existing schema without completely overwriting it.

Name

The identifier for the field within the schema. This is the name that will be used to reference the field in the data structure.

Type

It specifies the data type of the field.

Required

It indicates whether the field is mandatory.

Minimum Length

It defines the minimum number of characters or elements that the field must contain.

Maximum Length

It defines the maximum number of characters or elements that the field must contain.

Pattern

It is a regular expression that the field’s value must match. This is typically used for validating formats like email addresses, phone numbers, etc.

Help Text

It provides additional information or guidance on what the field represents and how it should be used. This is often displayed in the UI to assist users.

Default Value

It is a predefined value that the field will take if no other value is provided. This helps in setting initial values.

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.

For example,

Open

Object as Nested Entity

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.