Workflow Blueprints

How to manage, search, and publish new workflow instances from blueprints.

Workflow Blueprints enable users to define, manage, and publish reusable workflow templates. These blueprints streamline the process of creating workflows by breaking them into modular components like blocks, roles, and schemas. With Workflow Blueprints, developers and project owners can ensure consistency, scalability, and transparency across their workflows.

Key Benefits:

• Reusability: Easily replicate workflows for similar projects, saving time and effort.

• Traceability: Maintain full visibility into workflow components and execution history, ensuring accountability.

• Integration Ready: Publish workflows that seamlessly integrate with validation schemas and external systems.

Core workflow blueprint handling

These below methods are focused on working directly with workflows or blueprint, and how owners can publish, and understand what instances have connected status.

---

Workflows List

GET/api/v1/workflows

Query parameters

Response

200x-200:[Success] Workflow filter by key

Body

application/json

current_page*integer

data*array of object

first_page_url*string

from*integer

last_page*integer

last_page_url*string

links*array of object

next_page_url*null

path*string

per_page*integer

prev_page_url*null

to*integer

total*integer

Request

JavaScriptCurlPython

const response = await fetch('/api/v1/workflows', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200x-200:[Success] Workflow filter by key

{
  "current_page": 0,
  "data": [
    {
      "id": "text",
      "name": "text",
      "description": "text",
      "key": "text"
    }
  ],
  "first_page_url": "text",
  "from": 0,
  "last_page": 0,
  "last_page_url": "text",
  "links": [
    {
      "url": "text",
      "label": "text",
      "active": false
    }
  ],
  "path": "text",
  "per_page": 0,
  "to": 0,
  "total": 0
}

List all Workflow Blocks

GET/api/v1/workflows/workflow/blocks

Header parameters

Response

200x-200:[None/Failed] List Workflow Blocks

Body

application/json

id*string

workflow_id*string

block_id*string

parent_id*nullable string

child_id*nullable string

schema_id*nullable string

role_id*string

key*string

created_at*string

updated_at*string

Request

JavaScriptCurlPython

const response = await fetch('/api/v1/workflows/workflow/blocks', {
    method: 'GET',
    headers: {
      "Accept": "text"
    },
});
const data = await response.json();

Response

200x-200:[None/Failed] List Workflow Blocks

[
  {
    "id": "text",
    "workflow_id": "text",
    "block_id": "text",
    "parent_id": "text",
    "child_id": "text",
    "schema_id": "text",
    "role_id": "text",
    "key": "text",
    "created_at": "text",
    "updated_at": "text"
  }
]

List workflow owner instances

GET/api/v1/workflows/workflow/instances

Authorization

bearer

Query parameters

Header parameters

Response

200401

Body

application/json

current_page*integer

data*array of object

first_page_url*string

from*integer

last_page*integer

last_page_url*string

links*array of object

next_page_url*null

path*string

per_page*integer

prev_page_url*string

to*integer

total*integer

Request

JavaScriptCurlPython

const response = await fetch('/api/v1/workflows/workflow/instances?page=text', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>",
      "Accept": "text"
    },
});
const data = await response.json();

Response

200401

{
  "current_page": 0,
  "data": [
    {
      "id": "text",
      "user_id": 0,
      "workflow_id": "text",
      "workflow_status_id": "text",
      "key": "text",
      "created_at": "text",
      "updated_at": "text"
    }
  ],
  "first_page_url": "text",
  "from": 0,
  "last_page": 0,
  "last_page_url": "text",
  "links": [
    {
      "url": "text",
      "label": "text",
      "active": false
    }
  ],
  "path": "text",
  "per_page": 0,
  "prev_page_url": "text",
  "to": 0,
  "total": 0
}

Show workflow owner instance

GET/api/v1/workflows/workflow/instances/workflow_instance_id

Authorization

bearer

Header parameters

Response

200401

Body

application/json

data*object

Request

JavaScriptCurlPython

const response = await fetch('/api/v1/workflows/workflow/instances/workflow_instance_id', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>",
      "Accept": "text"
    },
});
const data = await response.json();

Response

200401

{
  "data": {
    "id": "text",
    "user_id": 0,
    "workflow_id": "text",
    "workflow_status_id": "text",
    "key": "text",
    "created_at": "text",
    "updated_at": "text",
    "status": "text"
  }
}

Workflow Publish

POST/api/v1/workflows/workflow/publish

Authorization

bearer

Header parameters

Body

text/plain

string

Response

200401403422

Body

application/json

workflow_instance_id*string

workflow_block_id*string

id*string

updated_at*string

created_at*string

workflow_block*object

Request

JavaScriptCurlPython

const response = await fetch('/api/v1/workflows/workflow/publish', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Accept": "text",
      "Content-Type": "text/plain"
    },
    body: JSON.stringify("// {\n//     \"key\": \"example-wf\"\n// }"),
});
const data = await response.json();

Response

200401403422

{
  "workflow_instance_id": "text",
  "workflow_block_id": "text",
  "id": "text",
  "updated_at": "text",
  "created_at": "text",
  "workflow_block": {
    "id": "text",
    "workflow_id": "text",
    "block_id": "text",
    "child_id": "text",
    "schema_id": "text",
    "role_id": "text",
    "key": "text",
    "created_at": "text",
    "updated_at": "text",
    "block": {
      "id": "text",
      "block_type_id": "text",
      "name": "text",
      "version": "text",
      "created_at": "text",
      "updated_at": "text",
      "block_type": {
        "id": "text",
        "type": "text",
        "key": "text",
        "created_at": "text",
        "updated_at": "text"
      }
    }
  }
}

Workflow Get Schemas

GET/api/v1/workflows/workflow/schemas

Authorization

bearer

Header parameters

Response

200

Body

application/json

data*array of object

Request

JavaScriptCurlPython

const response = await fetch('/api/v1/workflows/workflow/schemas', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "text",
      "Accept": "text"
    },
});
const data = await response.json();

Response

200

{
  "data": [
    {
      "block_id": "text",
      "schema_id": "text",
      "key": "text",
      "schema": [
        "text"
      ],
      "role": "text"
    }
  ]
}