Workflow Queries | Appsmith - SolFind Web Lens

Workflow Queries | Appsmith

https://docs.appsmith.com/workflows/reference/workflow-queries • 46 KB fetched
Open original page

Workflow Queries | Appsmith

Ask AI
Search

Ask Appsmith AI Submit message

Examples How do I install Appsmith using Docker? How do I connect to my local PostgreSQL database? How do I pass inputs from a widget to a query? How do I trigger multiple queries conditionally? How do I fix the error: This value does not evaluate to type Array<Object>?

Try Appsmith

* Get Started

* Introduction

* Build Your First App

* Self Hosting

* New Installation Guides

* Manage Installation

* Upgrade Installation Guides

* Concepts

* Connect Data

* Overview

* How-to Guides

* Reference

* Datasources

* Query Settings

* Concepts

* Build Apps

* Overview

* Quickstart

* How-to Guides

* Reference

* Widgets

* Accessibility

* Theme

* Sample Apps

* Write Code

* Overview

* How-to Guides

* Reference

* Global Objects

* Global Functions

* JS Libraries

* Fetch API

* Data Transformation

* JavaScript Settings

* Concepts

* Best Practices

* Manage Apps and Users

* Authentication

* Granular Access Control

* Versioning with Git

* Setup SCIM Provisioning

* Embed Appsmith

* Migrate Applications

* Audit Logs

* Branding

* External Client Portal

* Packages

* Overview

* Tutorial

* How-to Guides

* Reference

* Package Version Control

* GIT Apps with Packages Best Practices

* Code Packages

* UI Packages

* Workflows

* Overview

* Tutorial

* How-to Guides

* Reference

* Workflow Triggers

* Workflow Queries

* Workflow Functions

* Pass Parameters to Workflows

* Run History

* Troubleshooting

* Overview

* Self-hosting Errors

* Application Errors

* Product

* FAQ

* Security

* Telemetry

* Support at Appsmith

* Privacy Policy

* Release Notes

* Contribute

* Workflows

* Reference

* Workflow Queries
On this page
Workflow Queries
Business

Workflow queries in Appsmith applications enable interaction with workflows, allowing users to execute operations within their apps. This page provides detailed information on workflow queries and their parameters.

Workflow name

Specifies the workflow with which the Appsmith application will interact and execute operations. It allows users to select a specific workflow from all the workflows available in the workspace for interaction and execution.

Request type

Request type defines the operation to execute on the workflow. The available types are:

* Trigger Workflow: Triggers the workflow and executes it based on predefined conditions or events, along with the supplied parameters.

* Get Requests: Retrieve information about the requests generated as part of the workflow.

* Resolve Requests: Handles and concludes existing workflow requests raised as part of the Get Requests operation.

Trigger Workflow

A Trigger Workflow request initiates a workflow run with supplied parameters, and executes the predefined operations within the workflow.

Trigger data

Trigger data supplies the parameters needed by the workflow to execute. The parameters are supplied in a JSON object. For example:
{
"parameter1" : "value1" ,
"parameter2" : "value2"
}

Get requests

A Get Requests request retrieves the requests created as part of the workflow, specific to the logged-in user. These requests require human intervention for the user to verify and take action.

Request names

Filters the requests based on their name. One or more request names can be added to retrieve requests.

Request name

Specifies the name of the request to fetch, as defined while creating request using the assignRequests workflow function. For more information, see assignRequests .

Request status

Filters requests based on their status. The available statuses are: Pending and Resolved .

Limit

Specifies the maximum number of requests to retrieve. The default value is set to 10 .

Skip

Specifies the number of requests to skip before returning data. The default value is set to 0 .

Resolve requests

The Resolve requests request applies resolutions to existing workflow requests based on user actions.

Request Id

Specifies the ID of the request for which resolution is needed.

Resolution

Applies a resolution to the request based on the action taken. The resolution must match those specified while creating the request using the assignRequests workflow function. For example, during request creation, if you defined available resolutions as Approve and Reject , only these resolutions can be applied to the request when a user takes action. Therefore, when passing resolutions to this attribute, ensure they match the predefined options.

Metadata

Add data that may be needed to process the request or perform additional operation in the workflow. For example, you can include a unique identifier for the record associated with the request. Use the identifier in your workflow to fetch details and perform additional operation.

Workflow Queries | Appsmith

Links found on this page