Versions Compared

Version Old Version 7 New Version 8
Changes made by

Content Writers

Content Writers

Saved on

Key

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

Overview

  • API Type Model solely focuses on integrating with external web applications by using REST APIs, allowing seamless data retrieval and management from various web sources.

  • These models handle data exchange and can be bound various components, enabling efficient data display and interaction across various layouts.

...

  • Before heading to this section, we need to have some basic understanding about API connections. Let us go through that first.

Pre-requisites

Panel
bgColor#FFF0B3

...

Info

References:

...

In this section, you can see various option while creation model for API types let’s understand each:

...

Details

  • Let’s explore the screens that follow, after clicking on Model Creation + button and Type as API.

Details

In this tab, user can specify the REST API Connection for integration and its details, on whose basis model is to be created.

...

Details Config

Description

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.

Note: By default, Type is set as Record.

Authentication Type

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

Label

Assign a unique name to

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

Connection

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

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

  2. 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-20240926-072229.pngImage Added

Label

Allows to specify the name of the model.

Note: After choosing In case of Authentication Type set as Connection, after specifying Connection, this field auto-populates, mirroring the connection label, which can be edited later.

Name

Provide Allows to provide unique API name for the model.

Note: After choosing In case of Authentication Type set as Connection, after specifying Connection, this field auto-populates, mirroring replicating the connection name, which can be edited laterlabel in camel case.

Execute on Load

Enables records to be fetched automatically upon loading the component.

Request

...

In this tab, user can specify the REST API request that is sent to a server to access resource data.

...

Request Config Group

Config Name

Description

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.

Note: By default, Method is set as Post.

URLAdd

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

you wish

  • user wishes to perform CRUD.

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

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.

Headers

It is used to provide additional information about the request, such as the format of the request body, the client's preferred language, authentication credentials, and more

Info

Reference: Merge Text

Is Array?

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

Note: When enabled, it allows handling multiple records as a list, suitable for displaying data in components like Tables or Repeater. When disabled, it treats the data as a single record, ideal for components like Form.

Type

Allows to specify type of 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.

Note: When Is Array? is enabled, the Type is automatically set to Object by default and cannot be changed.

Request Body

Generate Schema

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

Info

Reference: Schema Designer

Create New Field

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

Info

Reference: Schema Designer

Response

In this tab, user can specify the REST API response that is sent by a server with resource data.

...

Response Config Group

Config Name

Description

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

Response Body

Generate Schema

It can define fields using JSON format.

Info

Reference: Schema Designer

Create New Field

It can create fields using the create field Model.

Info

Reference: Schema Designer

Merge Text

Include Page
Merge Text Config
Merge Text Config

Schema Designer

...

Generate Schema

...