Workflow Block Instance Processing

This section details how to interact with workflow instances by submitting data to different block types within a workflow. It covers both Approval Process Blocks and Data Process Blocks.

Submitting Block Types in Workflow Instances Workflow Block instances are the operational units of the DOVU OS Workflow Engine. Within each block instance, block types define specific stages or actions, such as data submission, validation, or approval processes. This section focuses on two primary block types:

1. Data Process Blocks: These blocks allow users to submit and store structured data related to the workflow. Typical use cases include collecting user information, project details, MRV data, or geographic data necessary for the workflow's progression.

2. Approval Process Blocks: These blocks facilitate decision-making steps in the workflow. Users can submit approvals or rejections, with optional messages explaining the decision. This ensures compliance and transparency in workflows requiring oversight or multiple stakeholders.

How It Works

• Each block is tied to a specific workflow instance ID and acts as a modular step in the broader workflow lifecycle.

• Each block is tied to a specific role that can act on the block, all roles are connected actors that must be prior connected to a workflow instance from the owner or registry actor.

• Developers can interact with these blocks via POST requests, submitting data that drives the instance forward or changes its state.

• Responses from these endpoints include metadata about the workflow instance, enabling further actions or integrations.

Key Use Cases:

• Submitting project data for environmental credit issuance.

• Approving or rejecting specific workflow stages to ensure compliance.

• Using returned data for visualization or tracking in front-end applications.

With these endpoints, developers can manage workflow instances dynamically, ensuring seamless integration of data submissions and approvals into the workflow lifecycle.

---

Data Process Block

POST/api/v1/workflow-block-instances/data_workflow_block_instance_id

Authorization

bearer

Header parameters

Body

application/json

name*string

age*integer

address*object

Response

200401404422

Body

application/json

id*string

workflow_instance_id*string

workflow_block_id*string

block_id*string

parent_id*null

next_block_instance_id*string

workflow_id*string

schema_id*string

role_id*string

block_type_id*string

name*string

child_id*string

key*string

type*string

latest_status_id*integer

updated_at*string

Request

JavaScriptCurlPython

const response = await fetch('/api/v1/workflow-block-instances/data_workflow_block_instance_id', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Accept": "text",
      "Content-Type": "application/json",
      "Referer": "text"
    },
    body: JSON.stringify({
      "name": "John Doe",
      "age": 30,
      "address": {
        "street": "123 Main St",
        "city": "Anytown",
        "postcode": "12345",
        "latlong": {
          "lat": "52.768211",
          "long": "-0.377180"
        }
      }
    }),
});
const data = await response.json();

Response

200401404422

{
  "id": "text",
  "workflow_instance_id": "text",
  "workflow_block_id": "text",
  "block_id": "text",
  "next_block_instance_id": "text",
  "workflow_id": "text",
  "schema_id": "text",
  "role_id": "text",
  "block_type_id": "text",
  "name": "text",
  "child_id": "text",
  "key": "text",
  "type": "text",
  "latest_status_id": 0,
  "updated_at": "text"
}

Approval Process Block

POST/api/v1/workflow-block-instances/approval_workflow_block_instance_id

Authorization

bearer

Header parameters

Body

application/json

approve*string

messsage*string

Response

200401422x-422:[Warning] Approval Process Block After Initial modificationx-422:[Fail] Use Correct Approval Keyx-422:[Fail] Cannot reprocess block when approved

Body

application/json

id*string

workflow_instance_id*string

workflow_block_id*string

block_id*string

parent_id*string

next_block_instance_id*string

workflow_id*string

schema_id*null

role_id*string

block_type_id*string

name*string

child_id*string

key*string

type*string

latest_status_id*integer

updated_at*string

Request

JavaScriptCurlPython

const response = await fetch('/api/v1/workflow-block-instances/approval_workflow_block_instance_id', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Accept": "text",
      "Content-Type": "application/json",
      "Referer": "text"
    },
    body: JSON.stringify({
      "approve": "approved",
      "messsage": "this is a approval/reject message"
    }),
});
const data = await response.json();

Response

200401422x-422:[Warning] Approval Process Block After Initial modificationx-422:[Fail] Use Correct Approval Keyx-422:[Fail] Cannot reprocess block when approved

{
  "id": "text",
  "workflow_instance_id": "text",
  "workflow_block_id": "text",
  "block_id": "text",
  "parent_id": "text",
  "next_block_instance_id": "text",
  "workflow_id": "text",
  "role_id": "text",
  "block_type_id": "text",
  "name": "text",
  "child_id": "text",
  "key": "text",
  "type": "text",
  "latest_status_id": 0,
  "updated_at": "text"
}