Skip to content

bpmn-server / APIEngine

Class: APIEngine#

Hierarchy#

  • APIComponent

↳ APIEngine

Implements#

Table of contents#

Constructors#

Properties#

Accessors#

Methods#

Constructors#

constructor#

• new APIEngine(api): APIEngine

Parameters#

Name Type
api any

Returns#

APIEngine

Inherited from#

APIComponent.constructor

Defined in#

packages/bpmn-server/src/API/API.ts:63

Properties#

api#

• api: BPMNAPI

Inherited from#

APIComponent.api

Defined in#

packages/bpmn-server/src/API/API.ts:61

Accessors#

server#

• get server(): IBPMNServer

Returns#

IBPMNServer

Inherited from#

APIComponent.server

Defined in#

packages/bpmn-server/src/API/API.ts:66

Methods#

getUser#

▸ getUser(user): any

Parameters#

Name Type
user any

Returns#

any

Inherited from#

APIComponent.getUser

Defined in#

packages/bpmn-server/src/API/API.ts:69

start#

▸ start(name, data?, user?, options?): Promise\<IExecution>

start a new Instance of specified model

Parameters#

Name Type Description
name any name of the model to start.
data Object -
user? ISecureUser user object {}
options IEngineOptions -

Returns#

Promise\<IExecution>

Implementation of#

IAPIEngine.start

Defined in#

packages/bpmn-server/src/API/API.ts:248

invoke#

▸ invoke(query, data?, user?, options?): Promise\<IExecution>

continue with the execution of a particular item that is in a wait state, typically a user task

Parameters#

Name Type
query any
data Object
user? ISecureUser
options IEngineOptions

Returns#

Promise\<IExecution>

Implementation of#

IAPIEngine.invoke

Defined in#

packages/bpmn-server/src/API/API.ts:253

assign#

▸ assign(query, data, assignment, user?, options?): Promise\<IExecution>

provide assignment data to a user task Also, updates item data

Parameters#

Name Type
query any
data any
assignment any
user? ISecureUser
options IEngineOptions

Returns#

Promise\<IExecution>

Implementation of#

IAPIEngine.assign

Defined in#

packages/bpmn-server/src/API/API.ts:259

throwMessage#

▸ throwMessage(messageId, data, messageMatchingKey, user?, options?): Promise\<IExecution>

throw a message with an id, system will identify receiving item

Parameters#

Name Type
messageId any
data any
messageMatchingKey any
user? ISecureUser
options IEngineOptions

Returns#

Promise\<IExecution>

Implementation of#

IAPIEngine.throwMessage

Defined in#

packages/bpmn-server/src/API/API.ts:264

throwSignal#

▸ throwSignal(signalId, data, messageMatchingKey, user?, options?): Promise\<any>

throw a signal with an id, system will identify receiving item(s)

Parameters#

Name Type
signalId any
data any
messageMatchingKey any
user? ISecureUser
options IEngineOptions

Returns#

Promise\<any>

Implementation of#

IAPIEngine.throwSignal

Defined in#

packages/bpmn-server/src/API/API.ts:270

startEvent#

▸ startEvent(query, elementId, data?, user?, options?): Promise\<IExecution>

start a second event node (in a subprocess) for a running instance

Parameters#

Name Type
query any
elementId any
data Object
user? ISecureUser
options IEngineOptions

Returns#

Promise\<IExecution>

Implementation of#

IAPIEngine.startEvent

Defined in#

packages/bpmn-server/src/API/API.ts:274

retry#

▸ retry(itemQuery, user?): Promise\<IExecution>

Runs a failed item's work again (its status error), and the instance on from it.

Parameters#

Name Type
itemQuery any
user? ISecureUser

Returns#

Promise\<IExecution>

Defined in#

packages/bpmn-server/src/API/API.ts:280

restart#

▸ restart(itemQuery, data, user, options?): Promise\<IExecution>

restarting an already completed instance at a particular node this function requires dataStore.enableSavePoints to be true in configuration.ts this add a savePoint for each item, allowing you to select that item to restore it

Parameters#

Name Type Description
itemQuery any Query to find a single item
data any -
user ISecureUser -
options Object -

Returns#

Promise\<IExecution>

Implementation of#

IAPIEngine.restart

Defined in#

packages/bpmn-server/src/API/API.ts:284

upgrade#

▸ upgrade(model, afterNodeIds, user?): Promise\<string[] | { errors: any }>

upgrade running instances with the latest revised bpmn model default behaviour is that running instances will retain the model at start However, this routine will upgrade already started instances with the revised model

Parameters#

Name Type Description
model any Model Name
afterNodeIds any list of nodeIds, to check if already started, don't apply the upgrade
user? ISecureUser -

Returns#

Promise\<string[] | { errors: any }>

Implementation of#

IAPIEngine.upgrade

Defined in#

packages/bpmn-server/src/API/API.ts:289

Comments