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

Name	Type
query	any
user	ISecureUser

Returns

Promise<object[]>

Defined in

API/API.ts:173

---

save

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

save a model to the modelStore

Parameters

Name	Type
name	any
source	any
svg	any
user?	ISecureUser

Returns

any

Defined in

API/API.ts:180

---

list

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

list all models authorized to the user

Parameters

Name	Type
query	any
user	ISecureUser

Returns

Promise<string[]>

Defined in

API/API.ts:184

---

findEvents

▸ findEvents(query, user?): any

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

Parameters

Name	Type
query	any
user?	ISecureUser

Returns

any

Defined in

API/API.ts:189

---

findStartEvents

▸ findStartEvents(query, user?): any

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

Parameters

Name	Type
query	any
user?	ISecureUser

Returns

any

Defined in

API/API.ts:194

---

delete

▸ delete(name, user?): any

delete the specified model

Parameters

Name	Type
name	any
user?	ISecureUser

Returns

any

Defined in

API/API.ts:199

---

rename

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

delete the specified model

Parameters

Name	Type
name	any
newName	any
user?	ISecureUser

Returns

any

Defined in

API/API.ts:203

---

getSource

▸ getSource(name, user?): any

returns the bpmn (xml) for the model

Parameters

Name	Type
name	any
user?	ISecureUser

Returns

any

Defined in

API/API.ts:207

---

load

▸ load(name, user?): any

load a model

Parameters

Name	Type
name	any
user?	ISecureUser

Returns

any

Defined in

API/API.ts:211

---

export

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

Exports the specified models based on a query to a folder

Parameters

Name	Type
query	any
folder	any
user?	ISecureUser

Returns

any

Defined in

API/API.ts:215