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

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

Request Body

{
    "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

Headers

{
    // Response
}

Last updated