API Introduction

An introduction to FlowWright APIs

Last published at: July 30th, 2024

Welcome to the FlowWright developer’s guide; this guide will help you navigate the FlowWright API using code and examples.

FlowWright provides a high-performance .Net API and a REST API.  If you are in the Microsoft technology stack/platform, it is recommended that you use the high-performance .Net API.  FlowWright can be easily accessed from any other platform using the REST API.

FlowWright Architecture Overview

 

FlowWright Concepts

•    A Process Definition (WD) is made up of steps, connections, and comments

•    A Process Instance (WI) is instantiated from a Workflow Definition

•    A Form Definition (FD) is made up of fields, text labels, and control

•    A Form Instance (FI) is instantiated from a Form Definition

 

FlowWright API Components

API consists of many components separated into design and runtime API components.

The high-performance API is structured based on Design and Run-time objects. Below is the .NET API's hierarchical structure.

 

FlowWright .NET API is fully documented; you can find the documentation HERE. The REST API is also fully documented and available HERE. REST API can also be thoroughly tested on our website.  FlowWright also provides the following guides with the software:

  • Getting started with the API
  • Developers Guide
  • Code Snippet Forum
  • NuGet Package

As you can see, there are many resources to get you going. If you are stuck, we are just a click away. Please post your questions on our support forum. All the above guides are available within the FlowWright application; check out the HELP section. We are here to help you and to make you successful.

On top of these APIs, we also have a modeling API.  Let's say you want to build a workflow process programmatically or walk the structure of the workflow process,   It's called "UIModel" API, and here's the structure of it:

 

 

FlowWright's modeling API gives you access to steps, connections, business objects, and their configuration using a simple API. As you can see, we have exposed everything within FlowWright for you to access.