APIData

Contents

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


getPendingUserTasks

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

Parameters

Name Type
query any
user? ISecureUser

Returns

Promise<IItemData[]>

Defined in

API/API.ts:252


findItems

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

Parameters

Name Type
query any
user? ISecureUser

Returns

Promise<IItemData[]>

Defined in

API/API.ts:260


findItem

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

Parameters

Name Type
query any
user? ISecureUser

Returns

Promise<IItemData>

Defined in

API/API.ts:265


findInstances

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

Parameters

Name Type
query any
user? ISecureUser
options? any

Returns

Promise<IInstanceData[]>

Defined in

API/API.ts:271


deleteInstances

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

Parameters

Name Type
query any
user? ISecureUser

Returns

Promise<void>

Defined in

API/API.ts:276