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)
})

Constructors

constructor

new OperateApiClient(options?): OperateApiClient
Parameters
- Optional options: {
  config?: DeepPartial<CamundaPlatform8Configuration>;
  oAuthProvider?: IOAuthProvider;
  }
  - Optional config?: DeepPartial<CamundaPlatform8Configuration>
  - Optional oAuthProvider?: IOAuthProvider
Returns OperateApiClient
Example
```
const operate = new OperateApiClient()
```
Throws
An error that may occur during API operations.
- Defined in src/operate/lib/OperateApiClient.ts:79

Properties

`Private` oAuthProvider

oAuthProvider: IOAuthProvider

`Private` rest

rest: Promise<Got>

`Private` tenantId

tenantId: undefined | string

`Private` userAgentString

userAgentString: string

Methods

`Protected` addTenantIdToFilter

addTenantIdToFilter<T>(query, tenantId?): Query<EnhanceWithTenantIdIfMissing<T>>
Type Parameters
- T
Parameters
- query: Query<T>
- tenantId: undefined | string = ...
Returns Query<EnhanceWithTenantIdIfMissing<T>>
- Defined in src/operate/lib/OperateApiClient.ts:134

deleteProcessInstance

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

Throws
Example
```
const operate = new OperateApiClient()
await operate.deleteProcessInstance(2251799819847322)
```
- Defined in src/operate/lib/OperateApiClient.ts:365

getDecisionDefinition

getDecisionDefinition(decisionDefinitionKey): Promise<DecisionDefinition>
Parameters
- decisionDefinitionKey: string | number
Returns Promise<DecisionDefinition>
Throws
- Defined in src/operate/lib/OperateApiClient.ts:247

getDecisionInstance

getDecisionInstance(decisionInstanceKey): Promise<DecisionInstance>
Parameters
- decisionInstanceKey: string | number
Returns Promise<DecisionInstance>
Throws
- Defined in src/operate/lib/OperateApiClient.ts:281

getDecisionRequirements

getDecisionRequirements(key): Promise<DecisionRequirements>
Parameters
- key: string | number
Returns Promise<DecisionRequirements>
- Defined in src/operate/lib/OperateApiClient.ts:628

getDecisionRequirementsXML

getDecisionRequirementsXML(key): Promise<string>
Parameters
- key: string | number
Returns Promise<string>
Throws
- Defined in src/operate/lib/OperateApiClient.ts:643

getFlownodeInstance

getFlownodeInstance(key): Promise<FlownodeInstance>
Parameters
- key: string | number
Returns Promise<FlownodeInstance>
Throws
- Defined in src/operate/lib/OperateApiClient.ts:496

`Private` getHeaders

getHeaders(): Promise<{
    accept: string;
    authorization: string;
    content-type: string;
    user-agent: string;
}>
Returns Promise<{
    accept: string;
    authorization: string;
    content-type: string;
    user-agent: string;
}>
- Defined in src/operate/lib/OperateApiClient.ts:122

getIncident

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

Throws
Example
```
const operate = new OperateApiClient()
const incident = await operate.getIncident(2251799818436725)
console.log(incident.message)
```
- Defined in src/operate/lib/OperateApiClient.ts:464

getJSONVariablesforProcess

getJSONVariablesforProcess<T>(processInstanceKey): Promise<T>
Type Parameters
- T extends {
  [key: string]: JSONDoc;
  }
Parameters
- processInstanceKey: string | number
Returns Promise<T>
Description
Retrieve the variables for a Process Instance as an object, given its key

Throws
- Defined in src/operate/lib/OperateApiClient.ts:557

getProcessDefinition

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

Throws
Camunda 8 Documentation

Example
```
const operate = new OperateApiClient()
const definition = await operate.getProcessDefinition(2251799817140074);
```
- Defined in src/operate/lib/OperateApiClient.ts:202

getProcessDefinitionXML

getProcessDefinitionXML(processDefinitionKey): Promise<string>
Parameters
- processDefinitionKey: string | number
Returns Promise<string>
- Defined in src/operate/lib/OperateApiClient.ts:213

getProcessInstance

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

Throws
Example
```
const operate = new OperateApiClient()
const instance = await operate.getProcessInstance(2251799819847322)
```
- Defined in src/operate/lib/OperateApiClient.ts:344

getProcessInstanceSequenceFlows

getProcessInstanceSequenceFlows(processInstanceKey): Promise<string[]>
Parameters
- processInstanceKey: string | number
Returns Promise<string[]>
Description
Get sequence flows of process instance by key

Throws
- Defined in src/operate/lib/OperateApiClient.ts:404

getProcessInstanceStatistics

getProcessInstanceStatistics(processInstanceKey): Promise<ProcessInstanceStatistics[]>
Parameters
- processInstanceKey: string | number
Returns Promise<ProcessInstanceStatistics[]>
Description
Get the statistics for a process instance, grouped by flow nodes

Throws
- Defined in src/operate/lib/OperateApiClient.ts:388

getVariables

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

Throws
- Defined in src/operate/lib/OperateApiClient.ts:601

getVariablesforProcess

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

Throws
- Defined in src/operate/lib/OperateApiClient.ts:533

`Private` safeJSONparse

safeJSONparse(thing): any
Parameters
- thing: string
Returns any
- Defined in src/operate/lib/OperateApiClient.ts:585

searchDecisionDefinitions

searchDecisionDefinitions(query): Promise<SearchResults<DecisionDefinition>>
Parameters
- query: Query<DecisionDefinition>
Returns Promise<SearchResults<DecisionDefinition>>
Throws
- Defined in src/operate/lib/OperateApiClient.ts:228

searchDecisionInstances

searchDecisionInstances(query): Promise<SearchResults<DecisionInstance>>
Parameters
- query: Query<DecisionInstance>
Returns Promise<SearchResults<DecisionInstance>>
Throws
- Defined in src/operate/lib/OperateApiClient.ts:262

searchDecisionRequirements

searchDecisionRequirements(query): Promise<unknown>
Parameters
- query: Query<DecisionRequirements>
Returns Promise<unknown>
Throws
- Defined in src/operate/lib/OperateApiClient.ts:614

searchFlownodeInstances

searchFlownodeInstances(query): Promise<SearchResults<FlownodeInstance>>
Parameters
- query: Query<FlownodeInstance>
Returns Promise<SearchResults<FlownodeInstance>>
Throws
- Defined in src/operate/lib/OperateApiClient.ts:477

searchIncidents

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

Parameters

query: Query<Incident> = {}

Returns Promise<SearchResults<Incident>>

Description

Search and retrieve incidents.

Throws

Example

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

searchProcessDefinitions

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

Parameters

query: Query<ProcessDefinition> = {}

Returns Promise<SearchResults<ProcessDefinition>>

Description

Search and retrieve process definitions.

Camunda 8 Documentation

Throws

Example

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

searchProcessInstances

searchProcessInstances(query?): Promise<SearchResults<ProcessInstance>>

Parameters

query: Query<ProcessInstance> = {}

Returns Promise<SearchResults<ProcessInstance>>

Description

Search and retrieve process instances.

Throws

Example

const operate = new OperateApiClient()
const query: Query<ProcessInstance>  = {
  filter: {
    processVersion: 1
  },
  size: 50,
  sort: [
    {
      field: "bpmProcessId",
      order: "ASC"
    }
  ]
}
const instances = await operate.searchProcessInstances(query)
console.log(`Found ${instances.total} instances`)

searchVariables

searchVariables(query): Promise<SearchResults<Operate.OperateDto.Variable>>
Parameters
- query: Query<Operate.OperateDto.Variable>
Returns Promise<SearchResults<Operate.OperateDto.Variable>>
Throws
- Defined in src/operate/lib/OperateApiClient.ts:511

Class OperateApiClient

Description

Example

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional config?: DeepPartial<CamundaPlatform8Configuration>

Optional oAuthProvider?: IOAuthProvider

Returns OperateApiClient

Example

Throws

Properties

Private oAuthProvider

Private rest

Private tenantId

Private userAgentString

Methods

Protected addTenantIdToFilter

Type Parameters

Parameters

Returns Query<EnhanceWithTenantIdIfMissing<T>>

deleteProcessInstance

Parameters

Returns Promise<ChangeStatus>

Description

Throws

Example

getDecisionDefinition

Parameters

Returns Promise<DecisionDefinition>

Throws

getDecisionInstance

Parameters

Returns Promise<DecisionInstance>

Throws

getDecisionRequirements

Parameters

Returns Promise<DecisionRequirements>

getDecisionRequirementsXML

Parameters

Returns Promise<string>

Throws

getFlownodeInstance

Parameters

Returns Promise<FlownodeInstance>

Throws

Private getHeaders

Returns Promise<{ accept: string; authorization: string; content-type: string; user-agent: string; }>

getIncident

Parameters

Returns Promise<Incident>

Description

Throws

Example

getJSONVariablesforProcess

Type Parameters

Parameters

Returns Promise<T>

Description

Throws

getProcessDefinition

Parameters

Returns Promise<ProcessDefinition>

Description

Throws

Example

getProcessDefinitionXML

Parameters

Returns Promise<string>

getProcessInstance

Parameters

Returns Promise<ProcessInstance>

Description

Throws

Example

getProcessInstanceSequenceFlows

`Optional` config?: DeepPartial<CamundaPlatform8Configuration>

`Optional` oAuthProvider?: IOAuthProvider

`Private` oAuthProvider

`Private` rest

`Private` tenantId

`Private` userAgentString

`Protected` addTenantIdToFilter

`Private` getHeaders

Returns Promise<{
accept: string;
authorization: string;
content-type: string;
user-agent: string;
}>

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

`Private` safeJSONparse