APIData - bpmnServer/bpmn-server GitHub Wiki

bpmn-server / APIData

Class: APIData

Hierarchy

  • APIComponent

    ↳ APIData

Table of contents

Constructors

Properties

Accessors

Methods

Constructors

constructor

• new APIData(api): APIData

Parameters

Name Type
api any

Returns

APIData

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

deleteInstances

▸ deleteInstances(query, user): Promise<void>

Parameters

Name Type
query any
user ISecureUser

Returns

Promise<void>

Defined in

API/API.ts:96

findInstances

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

Parameters

Name Type
query any
user ISecureUser
options any

Returns

Promise<IInstanceData[]>

Defined in

API/API.ts:92

findItem

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

Parameters

Name Type
query any
user ISecureUser

Returns

Promise<IItemData>

Defined in

API/API.ts:87

findItems

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

Parameters

Name Type
query any
user ISecureUser

Returns

Promise<IItemData[]>

Defined in

API/API.ts:83

getPendingUserTasks

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

Parameters

Name Type
query any
user ISecureUser

Returns

Promise<IItemData[]>

Defined in

API/API.ts:75

⚠️ **GitHub.com Fallback** ⚠️