Class TasklistApiClient

Description

The high-level client for the Tasklist GraphQL API

Example

Hierarchy

TasklistApiClient

Index

Constructors

constructor

new TasklistApiClient(): TasklistApiClient
Example
Description
Returns TasklistApiClient
- Defined in node_modules/camunda-tasklist-client/dist/lib/TasklistApiClient.d.ts:21

Properties

`Private` getHeaders

getHeaders: any

graphqlUrl

graphqlUrl: string

`Private` userAgentString

userAgentString: any

Methods

claimTask

claimTask(taskId: string, assignee: string, allowOverrideAssignment?: boolean): Promise<{
claimTask: Task;
}>
Description
https://docs.camunda.io/docs/apis-clients/tasklist-api/mutations/claim-task/
Parameters
- taskId: string
- assignee: string
- Optional allowOverrideAssignment: boolean
Returns Promise<{
claimTask: Task;
}>
- Defined in node_modules/camunda-tasklist-client/dist/lib/TasklistApiClient.d.ts:91

completeTask

completeTask(taskId: string, variables: JSONDoc): Promise<{
completeTask: Task;
}>
Description
https://docs.camunda.io/docs/apis-clients/tasklist-api/mutations/complete-task/
Parameters
- taskId: string
- variables: JSONDoc
Returns Promise<{
completeTask: Task;
}>
- Defined in node_modules/camunda-tasklist-client/dist/lib/TasklistApiClient.d.ts:99

deleteProcessInstance

deleteProcessInstance(processInstanceId: string): Promise<{
deleteProcessInstance: boolean;
}>
Description
Delete process instance data from the Tasklist ES by id. Returns true if the process instance is found and canceled, false if the process instance could not be found. Documentation.
Parameters
- processInstanceId: string
Returns Promise<{
deleteProcessInstance: boolean;
}>
- Defined in node_modules/camunda-tasklist-client/dist/lib/TasklistApiClient.d.ts:107

getAllTasks

getAllTasks<T>(fields?: TaskFields): Promise<{
tasks: TaskWithVariables<T>[];
}>
Type Parameters
- T = {
  [key: string]: any;
  }
Parameters
- Optional fields: TaskFields
Returns Promise<{
tasks: TaskWithVariables<T>[];
}>
- Defined in node_modules/camunda-tasklist-client/dist/lib/TasklistApiClient.d.ts:46

getCurrentUser

getCurrentUser(): Promise<User>
Description
https://docs.camunda.io/docs/apis-clients/tasklist-api/queries/current-user/

Returns Promise<User>
- Defined in node_modules/camunda-tasklist-client/dist/lib/TasklistApiClient.d.ts:73

getForm

getForm(id: string, processDefinitionId: string): Promise<{
form: Form;
}>
Description
https://docs.camunda.io/docs/apis-clients/tasklist-api/queries/form/
Parameters
- id: string
- processDefinitionId: string
Returns Promise<{
form: Form;
}>
- Defined in node_modules/camunda-tasklist-client/dist/lib/TasklistApiClient.d.ts:67

getTask

getTask<T>(id: string, fields?: TaskFields): Promise<{
task: TaskWithVariables<T>;
}>
Description
https://docs.camunda.io/docs/apis-clients/tasklist-api/queries/task/

Returns
Type Parameters
- T = {
  [key: string]: any;
  }
Parameters
- id: string
- Optional fields: TaskFields
Returns Promise<{
task: TaskWithVariables<T>;
}>
- Defined in node_modules/camunda-tasklist-client/dist/lib/TasklistApiClient.d.ts:57

getTasks

getTasks<T>(query: Partial<TaskQuery>, fields?: TaskFields): Promise<{
tasks: TaskWithVariables<T>[];
}>
Description
Query Tasklist for a list of tasks. See the API documentation.

Example
```
const tasklist = new TasklistApiClient()

async function getTasks() {
  const res = await tasklist.getTasks({
    state: TaskState.CREATED
  }, ['id', 'name', 'processName'])
  console.log(res ? 'Nothing' : JSON.stringify(res.tasks, null, 2))
  return res
}
```
Type Parameters
- T = {
  [key: string]: any;
  }
Parameters
- query: Partial<TaskQuery>
- Optional fields: TaskFields
  
  a list of fields to return in the query results
Returns Promise<{
tasks: TaskWithVariables<T>[];
}>
- Defined in node_modules/camunda-tasklist-client/dist/lib/TasklistApiClient.d.ts:41

getVariable

getVariable(id: string): Promise<Tasklist.Variable>
Description
https://docs.camunda.io/docs/apis-clients/tasklist-api/queries/variable/
Parameters
- id: string
Returns Promise<Tasklist.Variable>
- Defined in node_modules/camunda-tasklist-client/dist/lib/TasklistApiClient.d.ts:84

getVariables

getVariables(taskId: string, variableNames: string[]): Promise<void>
Description
https://docs.camunda.io/docs/apis-clients/tasklist-api/queries/variables/
Parameters
- taskId: string
- variableNames: string[]
Returns Promise<void>
- Defined in node_modules/camunda-tasklist-client/dist/lib/TasklistApiClient.d.ts:79

unclaimTask

unclaimTask(taskId: string): Promise<Task>
Description
https://docs.camunda.io/docs/apis-clients/tasklist-api/mutations/unclaim-task/
Parameters
- taskId: string
Returns Promise<Task>
- Defined in node_modules/camunda-tasklist-client/dist/lib/TasklistApiClient.d.ts:114

Class TasklistApiClient

Description

Example

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Example

Description

Returns TasklistApiClient

Properties

Private getHeaders

graphqlUrl

Private userAgentString

Methods

claimTask

Description

Parameters

taskId: string

assignee: string

Optional allowOverrideAssignment: boolean

Returns Promise<{ claimTask: Task; }>

completeTask

Description

Parameters

taskId: string

variables: JSONDoc

Returns Promise<{ completeTask: Task; }>

deleteProcessInstance

Description

Parameters

processInstanceId: string

Returns Promise<{ deleteProcessInstance: boolean; }>

getAllTasks

Type Parameters

T = { [key: string]: any; }

Parameters

Optional fields: TaskFields

Returns Promise<{ tasks: TaskWithVariables<T>[]; }>

getCurrentUser

Description

Returns Promise<User>

getForm

Description

Parameters

id: string

processDefinitionId: string

Returns Promise<{ form: Form; }>

getTask

Description

Returns

Type Parameters

T = { [key: string]: any; }

Parameters

id: string

Optional fields: TaskFields

Returns Promise<{ task: TaskWithVariables<T>; }>

getTasks

Description

Example

Type Parameters

T = { [key: string]: any; }

Parameters

query: Partial<TaskQuery>

Optional fields: TaskFields

Returns Promise<{ tasks: TaskWithVariables<T>[]; }>

getVariable

Description

Parameters

id: string

Returns Promise<Tasklist.Variable>

getVariables

Description

Parameters

taskId: string

variableNames: string[]

Returns Promise<void>

`Private` getHeaders

`Private` userAgentString

`Optional` allowOverrideAssignment: boolean

Returns Promise<{
claimTask: Task;
}>

Returns Promise<{
completeTask: Task;
}>

Returns Promise<{
deleteProcessInstance: boolean;
}>

T = {
[key: string]: any;
}

`Optional` fields: TaskFields

Returns Promise<{
tasks: TaskWithVariables<T>[];
}>

Returns Promise<{
form: Form;
}>

T = {
[key: string]: any;
}

`Optional` fields: TaskFields

Returns Promise<{
task: TaskWithVariables<T>;
}>

T = {
[key: string]: any;
}

`Optional` fields: TaskFields

Returns Promise<{
tasks: TaskWithVariables<T>[];
}>