bpmn-server / IAPIModel

Interface: IAPIModel#

common parameters:

• query: MongoDB query to locate the target instance or item

• user: an instance of ISecureUser object

Table of contents#

Methods#

• get
• save
• list
• findEvents
• findStartEvents
• delete
• rename
• getSource
• load
• export

Methods#

get#

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

retrieve Model data

Parameters#

Returns#

Promise\<object[]>

Defined in#

API/API.ts:172

save#

▸save(name,source,svg,user?):any

save a model to the modelStore

Parameters#

Returns#

any

Defined in#

API/API.ts:179

list#

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

list all models authorized to the user

Parameters#

Returns#

Promise\<string[]>

Defined in#

API/API.ts:183

findEvents#

▸findEvents(query,user?):any

returns Model Events (like timers) for authorized to the user and based on specifid query

Parameters#

Returns#

any

Defined in#

API/API.ts:188

findStartEvents#

▸findStartEvents(query,user?):any

returns Model Start Events for authorized to the user and based on specifid query

Parameters#

Returns#

any

Defined in#

API/API.ts:193

delete#

▸delete(name,user?):any

delete the specified model

Parameters#

Returns#

any

Defined in#

API/API.ts:198

rename#

▸rename(name,newName,user?):any

delete the specified model

Parameters#

Returns#

any

Defined in#

API/API.ts:202

getSource#

▸getSource(name,user?):any

returns the bpmn (xml) for the model

Parameters#

Returns#

any

Defined in#

API/API.ts:206

load#

▸load(name,user?):any

load a model

Parameters#

Returns#

any

Defined in#

API/API.ts:210

export#

▸export(query,folder,user?):any

Exports the specified models based on a query to a folder

Parameters#

Returns#

any

Defined in#

API/API.ts:214