Openapi

full width

• process-definitions
  • postDeploy a new process definition
  • getGet list of process definitions
  • getGet process definition
• process-instances
  • postCreate a new process instance
  • getGet list of running process instances
  • getGet state of a process instance selected by processInstanceId
  • getGet list of jobs for a process instance
  • getGet list of activities for a process instance
  • getGet list of visited flow elements for a process instance
  • getGet list of incidents for a process instance
• jobs
  • postComplete a job
  • postActivate jobs
• messages
  • postPublish a message
• incidents
  • postResolve an incident

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

http://localhost:8080/v1/process-definitions

Response samples

• 200
• 502

Content type

application/json

{

• "processDefinitionKey": "string"

}

Get list of process definitions

Responses

http://localhost:8080/v1/process-definitions

Response samples

• 200

Content type

application/json

{

• "items": [

  • {

    • "key": "string",
    • "version": 0,
    • "bpmnProcessId": "string"

    }

  ],
• "offset": 0,
• "size": 0,
• "count": 0

}

Get process definition

path Parameters

processDefinitionKey required

string

Responses

http://localhost:8080/v1/process-definitions/{processDefinitionKey}

Response samples

• 200
• 400
• 500

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

http://localhost:8080/v1/process-instances

Request samples

• Payload

Content type

application/json

{

• "processDefinitionKey": "string",
• "variables": { }

}

Response samples

• 200
• 400
• 500
• 502

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

http://localhost:8080/v1/process-instances

Response samples

• 200
• 400
• 500
• 502

Content type

application/json

{

• "partitions": [

  • {

    • "partition": 0,
    • "items": [

      • {

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

        }

      ]

    }

  ],
• "page": 0,
• "size": 0,
• "count": 0

}

Get state of a process instance selected by processInstanceId

path Parameters

processInstanceKey required

string

Responses

http://localhost:8080/v1/process-instances/{processInstanceKey}

Response samples

• 200
• 400
• 500
• 502

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

http://localhost:8080/v1/process-instances/{processInstanceKey}/jobs

Response samples

• 200
• 400
• 500
• 502

Content type

application/json

{

• "items": [

  • {

    • "key": "string",
    • "elementId": "string",
    • "type": "string",
    • "processInstanceKey": "string",
    • "state": "string",
    • "createdAt": "2019-08-24T14:15:22Z",
    • "variables": { }

    }

  ],
• "offset": 0,
• "size": 0,
• "count": 0

}

Get list of activities for a process instance

path Parameters

processInstanceKey required

string

Responses

http://localhost:8080/v1/process-instances/{processInstanceKey}/activities

Response samples

• 200
• 400
• 500
• 502

Content type

application/json

{

• "items": [

  • {

    • "key": "string",
    • "processInstanceKey": "string",
    • "processDefinitionKey": "string",
    • "createdAt": "2019-08-24T14:15:22Z",
    • "state": "string",
    • "elementId": "string",
    • "bpmnElementType": "string"

    }

  ],
• "offset": 0,
• "size": 0,
• "count": 0

}

Get list of visited flow elements for a process instance

path Parameters

processInstanceKey required

string

Responses

http://localhost:8080/v1/process-instances/{processInstanceKey}/history

Response samples

• 200
• 400
• 500
• 502

Content type

application/json

{

• "items": [

  • {

    • "key": "string",
    • "processInstanceKey": "string",
    • "createdAt": "2019-08-24T14:15:22Z",
    • "elementId": "string"

    }

  ],
• "offset": 0,
• "size": 0,
• "count": 0

}

Get list of incidents for a process instance

path Parameters

processInstanceKey required

string

Responses

http://localhost:8080/v1/process-instances/{processInstanceKey}/incidents

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "items": [

  • {

    • "key": "string",
    • "elementInstanceKey": "string",
    • "elementId": "string",
    • "processInstanceKey": "string",
    • "message": "string",
    • "createdAt": "2019-08-24T14:15:22Z",
    • "resolvedAt": "2019-08-24T14:15:22Z",
    • "executionToken": "string"

    }

  ],
• "offset": 0,
• "size": 0,
• "count": 0

}

jobs

Complete a job

Request Body schema: application/json

required

jobKey required	string
variables	object

Responses

http://localhost:8080/v1/jobs

Request samples

• Payload

Content type

application/json

{

• "jobKey": "string",
• "variables": { }

}

Response samples

• 400
• 502

Content type

application/json

{

• "code": "string",
• "message": "string"

}

Activate jobs

path Parameters

jobType required

string

Responses

http://localhost:8080/v1/jobs/{jobType}/activate

Response samples

• 200

Content type

application/json

[

• {

  • "key": "string",
  • "elementId": "string",
  • "type": "string",
  • "processInstanceKey": "string",
  • "state": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "variables": { }

  }

]

messages

Publish a message

Request Body schema: application/json

required

processInstanceKey required	string
messageName required	string
variables	object

Responses

http://localhost:8080/v1/messages

Request samples

• Payload

Content type

application/json

{

• "processInstanceKey": "string",
• "messageName": "string",
• "variables": { }

}

Response samples

• 400
• 502

Content type

application/json

{

• "code": "string",
• "message": "string"

}

incidents

Resolve an incident

path Parameters

incidentKey required

string

Responses

http://localhost:8080/v1/incident/{incidentKey}/resolve

Response samples

• 400
• 502

Content type

application/json

{

• "code": "string",
• "message": "string"

}