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

Create WorkflowInstance

POST https://baseline.provide.services/api/v1/workflows

Passing the id of a workflow as the value of the workflow_id field will spawn a WorkflowInstance based on the given Workflow

Headers

Name	Type	Description
authorization*	string	bearer <JWT> scoped for an Organization

Request Body

Name	Type	Description
name*	string	name of Workflow
workgroup_id*	uuid	id of related Workgroup
version	string	current Workflow version. Required for deployment
workflow_id*	string	id of workflow used to spawn WorkflowInstance

200: OK

{
    "id": "7279f7a7-6976-4d10-869b-36a15c8eeac6",
    "created_at": "2021-11-26T16:45:30.364582373Z",
    "status": "draft",
    "version": null,
    "name": "test",
    "participants": null,
    "workgroup_id": "a746d83d-6d5e-4d41-9588-300e7e7ff0bc",
    "workflow_id": null
}

Get WorkflowInstance Details

Get WorkflowInstance Details

GET https://baseline.provide.services/api/v1/workflows/:id

Retrieves detailed information for a specified WorkflowInstance

Path Parameters

Name	Type	Description
id*	uuid	id of WorkflowInstancefor which detailed information is desired

Headers

Name	Type	Description
authorizaton*	string	bearer <JWT> scoped for an Organization

200: OK

{
    // Response
}