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 useOrganization
is a participant in aWorkgroup
a valid
Workflow
has been created and successfully deployed
WorkflowInstance
Schema
WorkflowInstance
SchemaField | Type | Description |
---|---|---|
| uuid |
|
| date/time | timestamp of |
| date/time | timestamp of |
| object | arbitrary data pertaining to |
| array | list of |
| string | current |
| string | address of |
| string | current |
| uuid |
|
| uuid |
|
| array | list of |
API Requests
Create WorkflowInstance
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 |
Request Body
Name | Type | Description |
---|---|---|
name* | string | name of |
workgroup_id* | uuid |
|
version | string | current |
workflow_id* | string |
|
Get WorkflowInstance
Details
WorkflowInstance
DetailsGet 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 |
|
Headers
Name | Type | Description |
---|---|---|
authorizaton* | string | bearer <JWT> scoped for an |
Last updated