API Introduction

Last published at: May 2nd, 2023

Welcome to the FlowWright developer’s guide, this guide will help you navigate through 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, its 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 Workflow Definition (WD) is made up of steps, connections and comments

•    A Workflow 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, and they are:

•    deDesign – supports all design time operations, such as create/getting/managing workflow definitions

•    deWorkflowDefinition – manages a single workflow definition object, provides access to its properties and methods

•    deSnapshot – manages all operations for a given snapshot

•    deRuntime – manages all runtime operations, such as managing workflow instaces

•    deWorkflowInstace – manages a single workflow instance object, provides access to its properties and methods

•    deStepExecutionInfo – contains detail information for step execution data

•    deBusinessIntelligence – manages all business intelligence data operations

•    deExpression – manages all expression evaluation operations

•    deUser – manages all operations for the virtual workflow users

•    deEventServiceBus – manages all event sub bus operations, such as managing events

The high performance API is structured based on Design and Run-time objects, below is the hierarchical structure of the .NET API.

FlowWright .NET API is fully documented, you can find the documentation HERE. The REST API is also fully documented and its available HERE. REST API can be also fully tested right from 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, post your questions on our support forum.  All the above guides are available right 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, connection, business objects and also their configuration, using a simple to use API. As you can see we have exposed everything within FlowWright for you to access.

In FlowWright v9.8, the  API namespace has been changed from cDevWorkflow to FlowWright.  Make necessary changes to any custom built components such as Workflow steps, data types, event handlers to adapt to this change.