Skip to content

bpmn-server / APIModelReader

Class: APIModelReader#

Reading models: what runtime clients need to offer and run processes (the processes a user may start, documentation, task forms, diagrams). Scoped to the principal's tenant (modelsOwner).

Hierarchy#

  • APIComponent

↳ APIModelReader

↳↳ APIModel

Table of contents#

Constructors#

Properties#

Accessors#

Methods#

Constructors#

constructor#

• new APIModelReader(api): APIModelReader

Parameters#

Name Type
api any

Returns#

APIModelReader

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

get#

▸ get(query, user): Promise\<object[]>

Parameters#

Name Type
query any
user ISecureUser

Returns#

Promise\<object[]>

Defined in#

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

list#

▸ list(query, user?): Promise\<string[]>

Parameters#

Name Type
query any
user? ISecureUser

Returns#

Promise\<string[]>

Defined in#

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

findEvents#

▸ findEvents(query, user?): Promise\<any[]>

Parameters#

Name Type
query any
user? ISecureUser

Returns#

Promise\<any[]>

Defined in#

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

findStartEvents#

▸ findStartEvents(query, user?): Promise\<any[]>

Start events the principal may use: candidate starter users/groups apply.

Parameters#

Name Type
query any
user? ISecureUser

Returns#

Promise\<any[]>

Defined in#

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

getSource#

▸ getSource(name, user?): Promise\<string>

Parameters#

Name Type
name any
user? ISecureUser

Returns#

Promise\<string>

Defined in#

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

load#

▸ load(name, user?): Promise\<IDefinition>

Parameters#

Name Type
name any
user? ISecureUser

Returns#

Promise\<IDefinition>

Defined in#

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

verifyModel#

▸ verifyModel(nameOrSource, user?): Promise\<IModelVerification>

Checks a model for errors and likely mistakes without running it.

Parameters#

Name Type Description
nameOrSource string a saved model's name, or BPMN XML
user? ISecureUser -

Returns#

Promise\<IModelVerification>

Defined in#

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

Comments