APIModel

bpmn-server / APIModel

Class: APIModel

Hierarchy

• APIComponent

  ↳ APIModel

Table of contents

Constructors

• constructor

Properties

• api

Accessors

• server

Methods

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

Constructors

constructor

• new APIModel(api): APIModel

Parameters

Name	Type
api	any

Returns

APIModel

Inherited from

APIComponent.constructor

Defined in

API/API.ts:22

Properties

api

• api: BPMNAPI

Inherited from

APIComponent.api

Defined in

API/API.ts:20

Accessors

server

• get server(): IBPMNServer

Returns

IBPMNServer

Inherited from

APIComponent.server

Defined in

API/API.ts:25

Methods

delete

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

Parameters

Name	Type
name	any
user	ISecureUser

Returns

Promise<false | void>

Defined in

API/API.ts:126

---

export

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

Parameters

Name	Type
query	any
folder	any
user	ISecureUser

Returns

Promise<void>

Defined in

API/API.ts:142

---

findEvents

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

Parameters

Name	Type
query	any
user	ISecureUser

Returns

Promise<any[]>

Defined in

API/API.ts:117

---

findStartEvents

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

Parameters

Name	Type
query	any
user	ISecureUser

Returns

Promise<any[]>

Defined in

API/API.ts:121

---

getSource

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

Parameters

Name	Type
name	any
user	ISecureUser

Returns

Promise<string>

Defined in

API/API.ts:136

---

list

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

Parameters

Name	Type
user	ISecureUser

Returns

Promise<string[]>

Defined in

API/API.ts:110

---

load

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

Parameters

Name	Type
name	any
user	ISecureUser

Returns

Promise<IDefinition>

Defined in

API/API.ts:139

---

rename

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

Parameters

Name	Type
name	any
newName	any
user	ISecureUser

Returns

Promise<boolean>

Defined in

API/API.ts:131

---

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