bpmn-server / APIData

Class: APIData

Hierarchy

• APIComponent

↳ APIData

Table of contents

Constructors

• constructor

Properties

• api

Accessors

• server

Methods

• getUser
• getPendingUserTasks
• findItems
• findItem
• findInstances
• deleteInstances

Constructors

constructor

• new APIData(api): APIData

Parameters

Name	Type
api	any

Returns

APIData

Inherited from

APIComponent.constructor

Defined in

packages/bpmn-server/src/API/API.ts:63

Properties

api

• api: BPMNAPI

Inherited from

APIComponent.api

Defined in

packages/bpmn-server/src/API/API.ts:61

Accessors

server

• get server(): IBPMNServer

Returns

IBPMNServer

Inherited from

APIComponent.server

Defined in

packages/bpmn-server/src/API/API.ts:66

Methods

getUser

▸ getUser(user): any

Parameters

Name	Type
user	any

Returns

any

Inherited from

APIComponent.getUser

Defined in

packages/bpmn-server/src/API/API.ts:69

---

getPendingUserTasks

▸ getPendingUserTasks(query, user?): Promise\<IItemData[]>

Parameters

Name	Type
query	any
user?	ISecureUser

Returns

Promise\<IItemData[]>

Defined in

packages/bpmn-server/src/API/API.ts:296

---

findItems

▸ findItems(query, user?): Promise\<IItemData[]>

Parameters

Name	Type
query	any
user?	ISecureUser

Returns

Promise\<IItemData[]>

Defined in

packages/bpmn-server/src/API/API.ts:304

---

findItem

▸ findItem(query, user?): Promise\<IItemData>

Parameters

Name	Type
query	any
user?	ISecureUser

Returns

Promise\<IItemData>

Defined in

packages/bpmn-server/src/API/API.ts:309

---

findInstances

▸ findInstances(query, user?, options?): Promise\<IInstanceData[]>

Parameters

Name	Type
query	any
user?	ISecureUser
options?	any

Returns

Promise\<IInstanceData[]>

Defined in

packages/bpmn-server/src/API/API.ts:315

---

deleteInstances

▸ deleteInstances(query, user?): Promise\<{ deletedCount: number }>

Parameters

Name	Type
query	any
user?	ISecureUser

Returns

Promise\<{ deletedCount: number }>

Defined in

packages/bpmn-server/src/API/API.ts:322

Comments