Skip to main content
API docs by Redocly

BPMN Engine OpenAPI (0.1.0)

Download OpenAPI specification:Download

REST API for lib-bpmn-engine

process-definitions

Deploy a new process definition

Request Body schema: application/xml
required
string <xml>

Responses

Response samples

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

Get list of process definitions

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "offset": 0,
  • "size": 0,
  • "count": 0
}

Get process definition

path Parameters
processDefinitionKey
required
string

Responses

Response samples

Content type
application/json
{
  • "key": "string",
  • "version": 0,
  • "bpmnProcessId": "string",
  • "bpmnData": "string"
}

process-instances

Create a new process instance

Request Body schema: application/json
required
processDefinitionKey
required
string
variables
object

Responses

Request samples

Content type
application/json
{
  • "processDefinitionKey": "string",
  • "variables": { }
}

Response samples

Content type
application/json
{
  • "key": "string",
  • "processDefinitionKey": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "state": "active",
  • "variables": { }
}

Get list of running process instances

query Parameters
processDefinitionKey
required
string
page
integer <int32>
Default: 1
size
integer <int32>
Default: 10

Responses

Response samples

Content type
application/json
{
  • "partitions": [
    ],
  • "page": 0,
  • "size": 0,
  • "count": 0
}

Get state of a process instance selected by processInstanceId

path Parameters
processInstanceKey
required
string

Responses

Response samples

Content type
application/json
{
  • "key": "string",
  • "processDefinitionKey": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "state": "active",
  • "variables": { }
}

Get list of jobs for a process instance

path Parameters
processInstanceKey
required
string

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "offset": 0,
  • "size": 0,
  • "count": 0
}

Get list of activities for a process instance

path Parameters
processInstanceKey
required
string

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "offset": 0,
  • "size": 0,
  • "count": 0
}

Get list of visited flow elements for a process instance

path Parameters
processInstanceKey
required
string

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "offset": 0,
  • "size": 0,
  • "count": 0
}

Get list of incidents for a process instance

path Parameters
processInstanceKey
required
string

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "offset": 0,
  • "size": 0,
  • "count": 0
}

jobs

Complete a job

Request Body schema: application/json
required
jobKey
required
string
variables
object

Responses

Request samples

Content type
application/json
{
  • "jobKey": "string",
  • "variables": { }
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string"
}

Activate jobs

path Parameters
jobType
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

messages

Publish a message

Request Body schema: application/json
required
processInstanceKey
required
string
messageName
required
string
variables
object

Responses

Request samples

Content type
application/json
{
  • "processInstanceKey": "string",
  • "messageName": "string",
  • "variables": { }
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string"
}

incidents

Resolve an incident

path Parameters
incidentKey
required
string

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string"
}