Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 4 Next »

Overview

  • The Rest API action specifically adheres to the principles of REST (Representational State Transfer) architecture, which uses standard HTTP methods like GET, POST, PUT, and DELETE to interact with resources on remote servers.

  • In workflows, REST APIs enable applications to access, manipulate, or exchange data with other systems or cloud-based services.

  • This action is highly versatile and can be used to perform a wide range of tasks, such as fetching data from third-party services, updating records in remote databases, or interfacing with cloud storage systems.

  • By following REST principles, workflows can ensure compatibility and reliability in communication with external services, making this action a powerful tool for integrating various applications and systems.

Config

image-20240819-172947.png

Config Field

Description

Source API Type

It specifies the type of API being used as the source to query records.

Note: For now, we use API Models created in layout as Source API Type.

Model

It defines the Rest API model associated with the Source API Type chosen.

Action Details

image-20240819-173430.png

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

image-20240911-043804.png

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.

  • No labels