Skip to content

bpmn-server / BPMNAPI

Class: BPMNAPI#

root object to api

to create:

api=new BPMNAPI(new BPMNServer(...));

to use:

api.engine to access engine functions (start,invoke..) api.data to access dataStore functions (find.. delete) api.model to read models (list, start events, source, verify)

Changing models (save, delete, rename) is available only through BPMNAdminAPI.

api cli:

api engine start --name 'Buy Used Car' --data caseId 1003 api engine invoke --query name 'Buy Used Car' items.status wait name 'Buy' --data carModel 'Mazda 3' api data findItems --query name 'Buy Used Car' items.status wait

Hierarchy#

  • BPMNAPI

↳ BPMNAdminAPI

Table of contents#

Constructors#

Properties#

Constructors#

constructor#

• new BPMNAPI(server): BPMNAPI

Parameters#

Name Type
server IBPMNServer

Returns#

BPMNAPI

Defined in#

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

Properties#

server#

• server: IBPMNServer

Defined in#

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


engine#

• engine: APIEngine

Defined in#

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


data#

• data: APIData

Defined in#

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


model#

• model: APIModelReader

Read-only: changing models needs BPMNAdminAPI.

Defined in#

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

Comments