Skip to content

bpmn-server / APIModel

Class: APIModel#

Changing models: deployment and model-management tooling only (BPMNAdminAPI).

Hierarchy#

↳ APIModel

Table of contents#

Constructors#

Properties#

Accessors#

Methods#

Constructors#

constructor#

• new APIModel(api): APIModel

Parameters#

Name Type
api any

Returns#

APIModel

Inherited from#

APIModelReader.constructor

Defined in#

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

Properties#

api#

• api: BPMNAPI

Inherited from#

APIModelReader.api

Defined in#

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

Accessors#

server#

• get server(): IBPMNServer

Returns#

IBPMNServer

Inherited from#

APIModelReader.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#

APIModelReader.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[]>

Inherited from#

APIModelReader.get

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[]>

Inherited from#

APIModelReader.list

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[]>

Inherited from#

APIModelReader.findEvents

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[]>

Inherited from#

APIModelReader.findStartEvents

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>

Inherited from#

APIModelReader.getSource

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>

Inherited from#

APIModelReader.load

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>

Inherited from#

APIModelReader.verifyModel

Defined in#

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

save#

▸ save(name, source, svg, user?): Promise\<boolean>

Parameters#

Name Type
name any
source any
svg any
user? ISecureUser

Returns#

Promise\<boolean>

Defined in#

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

delete#

▸ delete(name, user?): Promise\<false | void>

Parameters#

Name Type
name any
user? ISecureUser

Returns#

Promise\<false | void>

Defined in#

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

rename#

▸ rename(name, newName, user?): Promise\<boolean>

Parameters#

Name Type
name any
newName any
user? ISecureUser

Returns#

Promise\<boolean>

Defined in#

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

export#

▸ export(query, folder, user?): Promise\<void>

Parameters#

Name Type
query any
folder any
user? ISecureUser

Returns#

Promise\<void>

Defined in#

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

Comments