bpmn-server / BPMNAdminAPI

Class: BPMNAdminAPI

Privileged API used by deployment and model-management tooling. Runtime integrations should receive BPMNAPI so they cannot mutate models.

Hierarchy

• BPMNAPI

↳ BPMNAdminAPI

Table of contents

Constructors

• constructor

Properties

• server
• engine
• data
• model

Constructors

constructor

• new BPMNAdminAPI(server): BPMNAdminAPI

Parameters

Name	Type
server	IBPMNServer

Returns

BPMNAdminAPI

Overrides

BPMNAPI.constructor

Defined in

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

Properties

server

• server: IBPMNServer

Inherited from

BPMNAPI.server

Defined in

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

---

engine

• engine: APIEngine

Inherited from

BPMNAPI.engine

Defined in

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

---

data

• data: APIData

Inherited from

BPMNAPI.data

Defined in

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

---

model

• model: APIModel

Read-only: changing models needs BPMNAdminAPI.

Overrides

BPMNAPI.model

Defined in

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

Comments