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#

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

retrieve Model data

Parameters#

Name	Type
`query`	`any`
`user`	`ISecureUser`

Returns#

Promise\<object[]>

Defined in#

API/API.ts:172

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:179

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:183

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:188

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:193

delete#

▸ delete(name, user?): any

delete the specified model

Parameters#

Name	Type
`name`	`any`
`user?`	`ISecureUser`

Returns#

any

Defined in#

API/API.ts:198

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:202

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:206

load#

▸ load(name, user?): any

load a model

Parameters#

Name	Type
`name`	`any`
`user?`	`ISecureUser`

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#

Name	Type
`query`	`any`
`folder`	`any`
`user?`	`ISecureUser`

Returns#

any

Defined in#

API/API.ts:214