Class OperateApiClient

Description

The high-level client for Operate.

Example

const operate = new OperateApiClient()

operate.searchProcessInstances({
    filter: {
        state: "ACTIVE"
    },
    size: 50
}).then(instances => {
    console.log(instances)
})

Hierarchy

OperateApiClient

Constructors

constructor

new OperateApiClient(options?: {
baseUrl?: string;
oauthProvider?: OAuthProviderImpl;
}): OperateApiClient
Example
```
const operate = new OperateApiClient()
```
Parameters
- Optional options: {
  baseUrl?: string;
  oauthProvider?: OAuthProviderImpl;
  }
  - Optional baseUrl?: string
  - Optional oauthProvider?: OAuthProviderImpl
Returns OperateApiClient
- Defined in node_modules/operate-api-client/dist/lib/OperateApiClient.d.ts:32

Properties

`Private` getHeaders

getHeaders: any

`Private` gotOptions

gotOptions: any

oauthProvider

oauthProvider: undefined | OAuthProviderImpl

`Private` safeJSONparse

safeJSONparse: any

`Private` userAgentString

userAgentString: any

Methods

deleteProcessInstance

deleteProcessInstance(processInstanceKey: string | number): Promise<ChangeStatus>
Description
Delete a specific process instance by key.

Example
```
const operate = new OperateApiClient()
await operate.deleteProcessInstance(2251799819847322)
```
Parameters
- processInstanceKey: string | number
Returns Promise<ChangeStatus>
- Defined in node_modules/operate-api-client/dist/lib/OperateApiClient.d.ts:110

getFlownodeInstance

getFlownodeInstance(key: string | number): Promise<FlownodeInstance>
Parameters
- key: string | number
Returns Promise<FlownodeInstance>
- Defined in node_modules/operate-api-client/dist/lib/OperateApiClient.d.ts:159

getIncident

getIncident(key: string | number): Promise<Incident>
Description
Retrieve an incident by incident key.

Example
```
const operate = new OperateApiClient()
const incident = await operate.getIncident(2251799818436725)
console.log(incident.message)
```
Parameters
- key: string | number
Returns Promise<Incident>
- Defined in node_modules/operate-api-client/dist/lib/OperateApiClient.d.ts:157

getJSONVariablesforProcess

getJSONVariablesforProcess<T>(processInstanceKey: string | number): Promise<T>
Description
Retrieve the variables for a Process Instance as an object, given its key

Returns
Type Parameters
- T extends {
  [key: string]: JSONDoc;
  }
Parameters
- processInstanceKey: string | number
Returns Promise<T>
- Defined in node_modules/operate-api-client/dist/lib/OperateApiClient.d.ts:174

getProcessDefinition

getProcessDefinition(processDefinitionKey: string | number): Promise<ProcessDefinition>
Description
Retrieve the metadata for a specific process definition, by key.

Camunda 8 Documentation

Example
```
const operate = new OperateApiClient()
const definition = await operate.getProcessDefinition(2251799817140074);
```
Parameters
- processDefinitionKey: string | number
Returns Promise<ProcessDefinition>
- Defined in node_modules/operate-api-client/dist/lib/OperateApiClient.d.ts:69

getProcessDefinitionXML

getProcessDefinitionXML(processDefinitionKey: string | number): Promise<string>
Parameters
- processDefinitionKey: string | number
Returns Promise<string>
- Defined in node_modules/operate-api-client/dist/lib/OperateApiClient.d.ts:70

getProcessInstance

getProcessInstance(processInstanceKey: string | number): Promise<ProcessInstance>
Description
Retrieve a specific process instance by id.

Example
```
const operate = new OperateApiClient()
const instance = await operate.getProcessInstance(2251799819847322)
```
Parameters
- processInstanceKey: string | number
Returns Promise<ProcessInstance>
- Defined in node_modules/operate-api-client/dist/lib/OperateApiClient.d.ts:101

getProcessInstanceSequenceFlows

getProcessInstanceSequenceFlows(processInstanceKey: string | number): Promise<string[]>
Description
Get sequence flows of process instance by key
Parameters
- processInstanceKey: string | number
Returns Promise<string[]>
- Defined in node_modules/operate-api-client/dist/lib/OperateApiClient.d.ts:124

getProcessInstanceStatistics

getProcessInstanceStatistics(processInstanceKey: string | number): Promise<{
    active: number;
    activityId: string;
    canceled: number;
    completed: number;
    incidents: number;
}[]>
Description
Get the statistics for a process instance, grouped by flow nodes
Parameters
- processInstanceKey: string | number
Returns Promise<{
    active: number;
    activityId: string;
    canceled: number;
    completed: number;
    incidents: number;
}[]>
- Defined in node_modules/operate-api-client/dist/lib/OperateApiClient.d.ts:114

getVariables

getVariables(variableKey: string | number): Promise<Operate.Variable>
Description
Return a variable identified by its variable key

Returns
Parameters
- variableKey: string | number
Returns Promise<Operate.Variable>
- Defined in node_modules/operate-api-client/dist/lib/OperateApiClient.d.ts:183

getVariablesforProcess

getVariablesforProcess(processInstanceKey: string | number): Promise<{
items: Operate.Variable[];
}>
Description
Retrieve the variables for a Process Instance, given its key

Returns
Parameters
- processInstanceKey: string | number
Returns Promise<{
items: Operate.Variable[];
}>
- Defined in node_modules/operate-api-client/dist/lib/OperateApiClient.d.ts:166

searchFlownodeInstances

searchFlownodeInstances(query: Query<FlownodeInstance>): Promise<SearchResults<FlownodeInstance>>
Parameters
- query: Query<FlownodeInstance>
Returns Promise<SearchResults<FlownodeInstance>>
- Defined in node_modules/operate-api-client/dist/lib/OperateApiClient.d.ts:158

searchIncidents

searchIncidents(query?: Query<Incident>): Promise<SearchResults<Incident>>

Description

Search and retrieve incidents.

Example

const operate = new OperateApiClient()
const query: Query<Incident> = {
  filter: {
    state: "ACTIVE"
  },
  size: 50,
  sort: [
    {
      field: "creationTime",
      order: "ASC"
    }
  ]
}
const incidents = operate.searchIncidents(query)

Parameters

Optional query: Query<Incident>

Returns Promise<SearchResults<Incident>>

searchProcessDefinitions

searchProcessDefinitions(query?: Query<ProcessDefinition>): Promise<SearchResults<ProcessDefinition>>

Description

Search and retrieve process definitions.

Camunda 8 Documentation

Example

const query: Query<ProcessDefinition> = {
  filter: {},
  size: 50,
  sort: [
    {
      field: "bpmnProcessId",
      order: "ASC",
    },
   ],
 };
const operate = newOperateClient()
const defs = await operate.searchProcessDefinitions(query);

Parameters

Optional query: Query<ProcessDefinition>

Returns Promise<SearchResults<ProcessDefinition>>

searchProcessInstances

searchProcessInstances(query?: Query<ProcessInstance>): Promise<SearchResults<ProcessInstance>>
Description
Search and retrieve process instances.

Example
``` const operate = new OperateApiClient() const query: Query = { filter: { processVersion: 1 }, size: 50, sort: [ { field: "bpmProcessId", order: "ASC" } ] } const instances = await operate.searchProcessInstances(query) console.log(Found ${instances.total} instances)
Parameters
- Optional query: Query<ProcessInstance>
Returns Promise<SearchResults<ProcessInstance>>
- Defined in node_modules/operate-api-client/dist/lib/OperateApiClient.d.ts:91

searchVariables

searchVariables(query: Query<Operate.Variable>): Promise<SearchResults<Operate.Variable>>
Parameters
- query: Query<Operate.Variable>
Returns Promise<SearchResults<Operate.Variable>>
- Defined in node_modules/operate-api-client/dist/lib/OperateApiClient.d.ts:160

Class OperateApiClient

Description

Example

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Example

Parameters

Optional options: { baseUrl?: string; oauthProvider?: OAuthProviderImpl; }

Optional baseUrl?: string

Optional oauthProvider?: OAuthProviderImpl

Returns OperateApiClient

Properties

Private getHeaders

Private gotOptions

oauthProvider

Private safeJSONparse

Private userAgentString

Methods

deleteProcessInstance

Description

Example

Parameters

processInstanceKey: string | number

Returns Promise<ChangeStatus>

getFlownodeInstance

Parameters

key: string | number

Returns Promise<FlownodeInstance>

getIncident

Description

Example

Parameters

key: string | number

Returns Promise<Incident>

getJSONVariablesforProcess

Description

Returns

Type Parameters

T extends { [key: string]: JSONDoc; }

Parameters

processInstanceKey: string | number

Returns Promise<T>

getProcessDefinition

Description

Example

Parameters

processDefinitionKey: string | number

Returns Promise<ProcessDefinition>

getProcessDefinitionXML

Parameters

processDefinitionKey: string | number

Returns Promise<string>

getProcessInstance

Description

Example

Parameters

processInstanceKey: string | number

Returns Promise<ProcessInstance>

getProcessInstanceSequenceFlows

Description

Parameters

processInstanceKey: string | number

Returns Promise<string[]>

getProcessInstanceStatistics

Description

Parameters

processInstanceKey: string | number

Returns Promise<{ active: number; activityId: string; canceled: number; completed: number; incidents: number; }[]>

getVariables

Description

Returns

Parameters

variableKey: string | number

Returns Promise<Operate.Variable>

getVariablesforProcess

`Optional` options: {
baseUrl?: string;
oauthProvider?: OAuthProviderImpl;
}

`Optional` baseUrl?: string

`Optional` oauthProvider?: OAuthProviderImpl

`Private` getHeaders

`Private` gotOptions

`Private` safeJSONparse

`Private` userAgentString

T extends {
[key: string]: JSONDoc;
}

Returns Promise<{
active: number;
activityId: string;
canceled: number;
completed: number;
incidents: number;
}[]>

Returns Promise<{
items: Operate.Variable[];
}>

`Optional` query: Query<Incident>

`Optional` query: Query<ProcessDefinition>

`Optional` query: Query<ProcessInstance>