Search…
⌃K

Workflow Instances

Overview

A WorkflowInstance is a real-time execution of a deployed workflow. Workflow instances are spawned when the prime-workstep within a deployed within is triggered. A single deployed workflow can spawn an unlimited number of workflow instances.

Using Workflow Instances

Prerequisites

The Workflows API is intended to function within the context of an Organization acting as a Participant in a Workgroup.
Within this context, it is assumed that:
  • an Organization scoped JWT is available for use
  • Organization is a participant in a Workgroup
  • a valid Workflow has been created and successfully deployed

WorkflowInstance Schema

Field
Type
Description
id
uuid
id of Workflow
created_at
date/time
timestamp of Workflow creation
deployed_at
date/time
timestamp of Workflow deployment
metadata
object
arbitrary data pertaining to Workflow
participants
array
list of Participant objects included in a Workflow
status
string
current Workflow status
shield
string
address of shield contract
version
string
current Workflow version; required for deployment
workgroup_id
uuid
id of target Workgroup
workflow_id
uuid
id of Workflow prototype used in the spawning of the WorkflowInstance
worksteps
array
list of WorkstepInstance objects included in a WorkflowInstance

API Requests

Create WorkflowInstance

post
https://baseline.provide.services
/api/v1/workflows
Create WorkflowInstance

Get WorkflowInstance Details

get
https://baseline.provide.services
/api/v1/workflows/:id
Get WorkflowInstance Details
Last modified 8mo ago