Skip to main content
API docs by Redocly

Workflow Engine (0.0.1)

Download OpenAPI specification:Download

Nisarg Bhatt: nisargrbhatt@gmail.com URL: https://github.com/nisargrbhatt

The Workflow Engine API

AppController_health

Responses

Definition

Workflow Definition List

It will return array of Definition documents from the database

Authorizations:
jwt

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Workflow Definition Create

It will create new definition in database

Authorizations:
jwt
Request Body schema: application/json
required
object

Workflow Definition Data

key
required
string

Frontend Framework slug

ui
object

UI Object

Responses

Request samples

Content type
application/json
{
  • "workflowData": {
    },
  • "key": "string",
  • "ui": {
    }
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "tasks": [
    ],
  • "global": { },
  • "status": "active",
  • "uiObject": { },
  • "userId": "string"
}

Workflow Definition Edit

It will update definition in database

Authorizations:
jwt
path Parameters
id
required
any (id)

Definition Id

Request Body schema: application/json
required
object

Workflow Definition Data

key
required
string

Frontend Framework slug

ui
object

UI Object

Responses

Request samples

Content type
application/json
{
  • "workflowData": {
    },
  • "key": "string",
  • "ui": {
    }
}

Workflow Definition Detail

It will return definition document with all corelated runtime documents also

Authorizations:
jwt
path Parameters
id
required
any (id)

Definition Id

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "tasks": [
    ],
  • "global": { },
  • "status": "active",
  • "uiObject": { },
  • "userId": "string"
}

Workflow Definition

It will return definition document

Authorizations:
jwt
path Parameters
id
required
any (id)

Definition Id

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "tasks": [
    ],
  • "global": { },
  • "status": "active",
  • "uiObject": { },
  • "userId": "string"
}

Runtime

Workflow Runtime Detail

It will return runtime document with corelated definition document

Authorizations:
jwt
path Parameters
id
required
any (id)

Runtime Id

Responses

Response samples

Content type
application/json
{
  • "userId": "string"
}

Transport

Workflow Engine Start

It will start workflow engine for specified definition with addition of global params

Authorizations:
jwt
Request Body schema: application/json
workflowDefinitionId
required
string

Workflow Definition Id

globalParams
object

Workflow GlobalParams

Responses

Request samples

Content type
application/json
{
  • "workflowDefinitionId": "string",
  • "globalParams": { }
}

Workflow Engine Process

It will start workflow engine for specified task name. This is Internal Path used by engine itself as HTTP Transport

Authorizations:
basic
Request Body schema: application/json
workflowRuntimeId
required
string

Workflow Runtime Id

taskName
required
string

Workflow Definition Task Name

Responses

Request samples

Content type
application/json
{
  • "workflowRuntimeId": "string",
  • "taskName": "string"
}

Process Listen Task

It will Process Listen Task with globalParams update

header Parameters
x-api-key
required
string

Listen Task Security

Request Body schema: application/json
workflowRuntimeId
required
string

Workflow Runtime Id

taskName
required
string

Workflow Definition Task Name

globalParams
object

Workflow GlobalParams

Responses

Request samples

Content type
application/json
{
  • "workflowRuntimeId": "string",
  • "taskName": "string",
  • "globalParams": { }
}