API

Config

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. 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. 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. Note: This option is only visible, if one chooses Source API Type as URL.
Query Params	It lists the query parameters included in the API request. Reference: Query Params 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. Reference: Request Body Note: This option is only visible, if one chooses Source API Type as URL.
Responses	It defines the expected responses from the API. 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.

Request Body

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.

Responses

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. Reference: Request Body

Action Details

Attribute Name	Description
Label	A user-friendly name for the action, used for easy identification within the application.
Name	The unique identifier for the action, typically used in code or within merge text.
Is Async?	Decides whether the action will be performed in async context or within sync context.
Description	A user-friendly description for the action, used for easy apprehend within the application.

Is Async : Brief Explaination

Is Async checkbox provides flexibility in managing how actions within workflows are executed in relation to system transactions. Here's how it works:

Single Transaction Execution: When multiple actions within a workflow have Is Async set to false, they are executed within a single transaction. This ensures that all actions complete successfully, or if one fails, the entire transaction is rolled back, maintaining data integrity.
Breaking Transactions: When an action within the workflow has Is Async set to true, a new transaction is initiated at that point. This allows for separation between the actions, enabling different parts of the workflow to be processed independently.
Handling Large Data: The Is Async feature is especially useful when working with large amounts of data that may risk hitting system governor limits. By setting certain actions as asynchronous, you can ensure that the workflow avoids limits by breaking the execution into multiple transactions.

This feature empowers users to control how workflows behave during execution, optimizing performance and avoiding potential issues with system resources.

API