bpmn-server / APIModel

Class: APIModel

Hierarchy

• APIComponent

  ↳ APIModel

Table of contents

Constructors

• constructor

Properties

• api

Accessors

• server

Methods

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

Constructors

constructor

• new APIModel(api): APIModel

Parameters

Name	Type
api	any

Returns

APIModel

Inherited from

APIComponent.constructor

Defined in

API/API.ts:44

Properties

api

• api: BPMNAPI

Inherited from

APIComponent.api

Defined in

API/API.ts:42

Accessors

server

• get server(): IBPMNServer

Returns

IBPMNServer

Inherited from

APIComponent.server

Defined in

API/API.ts:47

Methods

getUser

▸ getUser(user): any

Parameters

Name	Type
user	any

Returns

any

Inherited from

APIComponent.getUser

Defined in

API/API.ts:50

---

get

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

Parameters

Name	Type
query	any
user	ISecureUser

Returns

Promise<object[]>

Defined in

API/API.ts:284

---

save

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

Parameters

Name	Type
name	any
source	any
svg	any
user?	ISecureUser

Returns

Promise<boolean>

Defined in

API/API.ts:295

---

list

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

Parameters

Name	Type
query	any
user?	ISecureUser

Returns

Promise<string[]>

Defined in

API/API.ts:303

---

findEvents

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

Parameters

Name	Type
query	any
user?	ISecureUser

Returns

Promise<any[]>

Defined in

API/API.ts:310

---

findStartEvents

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

Parameters

Name	Type
query	any
user?	ISecureUser

Returns

Promise<any[]>

Defined in

API/API.ts:315

---

delete

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

Parameters

Name	Type
name	any
user?	ISecureUser

Returns

Promise<false | void>

Defined in

API/API.ts:322

---

rename

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

Parameters

Name	Type
name	any
newName	any
user?	ISecureUser

Returns

Promise<boolean>

Defined in

API/API.ts:327

---

getSource

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

Parameters

Name	Type
name	any
user?	ISecureUser

Returns

Promise<string>

Defined in

API/API.ts:334

---

load

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

Parameters

Name	Type
name	any
user?	ISecureUser

Returns

Promise<IDefinition>

Defined in

API/API.ts:337

---

export

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

Parameters

Name	Type
query	any
folder	any
user?	ISecureUser

Returns

Promise<void>

Defined in

API/API.ts:340