Class AdminApiClient
Index
Constructors
Properties
Methods
Constructors
constructor
- new
Admin Api Client(options?): AdminApiClient Parameters
Optionaloptions: {
config?: DeepPartial<{
CAMUNDA_CONSOLE_BASE_URL: undefined | string;
CAMUNDA_CONSOLE_CLIENT_ID: undefined | string;
CAMUNDA_CONSOLE_CLIENT_SECRET: undefined | string;
CAMUNDA_CONSOLE_OAUTH_AUDIENCE: string;
CAMUNDA_CUSTOM_CERT_CHAIN_PATH: undefined | string;
CAMUNDA_CUSTOM_PRIVATE_KEY_PATH: undefined | string;
CAMUNDA_CUSTOM_ROOT_CERT_PATH: undefined | string;
CAMUNDA_CUSTOM_USER_AGENT_STRING: undefined | string;
CAMUNDA_MODELER_BASE_URL: string;
CAMUNDA_MODELER_OAUTH_AUDIENCE: undefined | string;
CAMUNDA_OAUTH_DISABLED: boolean;
CAMUNDA_OAUTH_TOKEN_REFRESH_THRESHOLD_MS: number;
CAMUNDA_OAUTH_URL: undefined | string;
CAMUNDA_OPERATE_BASE_URL: undefined | string;
CAMUNDA_OPERATE_OAUTH_AUDIENCE: string;
CAMUNDA_OPTIMIZE_BASE_URL: undefined | string;
CAMUNDA_OPTIMIZE_OAUTH_AUDIENCE: string;
CAMUNDA_SECURE_CONNECTION: boolean;
CAMUNDA_TASKLIST_BASE_URL: undefined | string;
CAMUNDA_TASKLIST_OAUTH_AUDIENCE: string;
CAMUNDA_TENANT_ID: undefined | string;
CAMUNDA_TOKEN_CACHE_DIR: undefined | string;
CAMUNDA_TOKEN_DISK_CACHE_DISABLE: boolean;
CAMUNDA_TOKEN_SCOPE: undefined | string;
CAMUNDA_ZEEBE_OAUTH_AUDIENCE: string;
ZEEBE_ADDRESS: string;
ZEEBE_CLIENT_ID: undefined | string;
ZEEBE_CLIENT_SECRET: undefined | string;
zeebeGrpcSettings: {
GRPC_HTTP2_MAX_PINGS_WITHOUT_DATA: number;
GRPC_HTTP2_MIN_PING_INTERVAL_WITHOUT_DATA_MS: number;
GRPC_HTTP2_MIN_TIME_BETWEEN_PINGS_MS: number;
GRPC_INITIAL_RECONNECT_BACKOFF_MS: string | number;
GRPC_KEEPALIVE_PERMIT_WITHOUT_CALLS: number;
GRPC_KEEPALIVE_TIMEOUT_MS: number;
GRPC_KEEPALIVE_TIME_MS: number;
GRPC_MAX_RECONNECT_BACKOFF_MS: string | number;
GRPC_MIN_RECONNECT_BACKOFF_MS: string | number;
ZEEBE_CLIENT_LOG_LEVEL: string;
ZEEBE_CLIENT_LOG_TYPE: string;
ZEEBE_GRPC_CLIENT_CONNECTION_TOLERANCE_MS: number;
ZEEBE_GRPC_CLIENT_EAGER_CONNECT: boolean;
ZEEBE_GRPC_CLIENT_INITIAL_CONNECTION_TOLERANCE_MS: undefined | number;
ZEEBE_GRPC_CLIENT_MAX_RETRIES: number;
ZEEBE_GRPC_CLIENT_MAX_RETRY_TIMEOUT_SECONDS: number;
ZEEBE_GRPC_CLIENT_RETRY: boolean;
ZEEBE_GRPC_WORKER_LONGPOLL_SECONDS: number;
ZEEBE_GRPC_WORKER_POLL_INTERVAL_MS: number;
};
}>;
oAuthProvider?: IOAuthProvider;
}Optionalconfig?: DeepPartial<{
CAMUNDA_CONSOLE_BASE_URL: undefined | string;
CAMUNDA_CONSOLE_CLIENT_ID: undefined | string;
CAMUNDA_CONSOLE_CLIENT_SECRET: undefined | string;
CAMUNDA_CONSOLE_OAUTH_AUDIENCE: string;
CAMUNDA_CUSTOM_CERT_CHAIN_PATH: undefined | string;
CAMUNDA_CUSTOM_PRIVATE_KEY_PATH: undefined | string;
CAMUNDA_CUSTOM_ROOT_CERT_PATH: undefined | string;
CAMUNDA_CUSTOM_USER_AGENT_STRING: undefined | string;
CAMUNDA_MODELER_BASE_URL: string;
CAMUNDA_MODELER_OAUTH_AUDIENCE: undefined | string;
CAMUNDA_OAUTH_DISABLED: boolean;
CAMUNDA_OAUTH_TOKEN_REFRESH_THRESHOLD_MS: number;
CAMUNDA_OAUTH_URL: undefined | string;
CAMUNDA_OPERATE_BASE_URL: undefined | string;
CAMUNDA_OPERATE_OAUTH_AUDIENCE: string;
CAMUNDA_OPTIMIZE_BASE_URL: undefined | string;
CAMUNDA_OPTIMIZE_OAUTH_AUDIENCE: string;
CAMUNDA_SECURE_CONNECTION: boolean;
CAMUNDA_TASKLIST_BASE_URL: undefined | string;
CAMUNDA_TASKLIST_OAUTH_AUDIENCE: string;
CAMUNDA_TENANT_ID: undefined | string;
CAMUNDA_TOKEN_CACHE_DIR: undefined | string;
CAMUNDA_TOKEN_DISK_CACHE_DISABLE: boolean;
CAMUNDA_TOKEN_SCOPE: undefined | string;
CAMUNDA_ZEEBE_OAUTH_AUDIENCE: string;
ZEEBE_ADDRESS: string;
ZEEBE_CLIENT_ID: undefined | string;
ZEEBE_CLIENT_SECRET: undefined | string;
zeebeGrpcSettings: {
GRPC_HTTP2_MAX_PINGS_WITHOUT_DATA: number;
GRPC_HTTP2_MIN_PING_INTERVAL_WITHOUT_DATA_MS: number;
GRPC_HTTP2_MIN_TIME_BETWEEN_PINGS_MS: number;
GRPC_INITIAL_RECONNECT_BACKOFF_MS: string | number;
GRPC_KEEPALIVE_PERMIT_WITHOUT_CALLS: number;
GRPC_KEEPALIVE_TIMEOUT_MS: number;
GRPC_KEEPALIVE_TIME_MS: number;
GRPC_MAX_RECONNECT_BACKOFF_MS: string | number;
GRPC_MIN_RECONNECT_BACKOFF_MS: string | number;
ZEEBE_CLIENT_LOG_LEVEL: string;
ZEEBE_CLIENT_LOG_TYPE: string;
ZEEBE_GRPC_CLIENT_CONNECTION_TOLERANCE_MS: number;
ZEEBE_GRPC_CLIENT_EAGER_CONNECT: boolean;
ZEEBE_GRPC_CLIENT_INITIAL_CONNECTION_TOLERANCE_MS: undefined | number;
ZEEBE_GRPC_CLIENT_MAX_RETRIES: number;
ZEEBE_GRPC_CLIENT_MAX_RETRY_TIMEOUT_SECONDS: number;
ZEEBE_GRPC_CLIENT_RETRY: boolean;
ZEEBE_GRPC_WORKER_LONGPOLL_SECONDS: number;
ZEEBE_GRPC_WORKER_POLL_INTERVAL_MS: number;
};
}>OptionaloAuth Provider?: IOAuthProvider
Returns AdminApiClient
Properties
Private o
Private rest
rest: Got
Private user
user
Methods
create
- create
Client(req): Promise<CreatedClusterClient> Parameters
- req: {
clientName: string;
clusterUuid: string;
permissions: string[];
}client
Name: string cluster
Uuid: string permissions: string[]
Returns Promise<CreatedClusterClient>
- req: {
create
- create
Cluster(createClusterRequest): Promise<{
clusterId: string;
}> Parameters
- createClusterRequest: CreateClusterBody
Returns Promise<{
clusterId: string;
}>Description
Create a new cluster. See the API Documentation for more details.
-
create
- create
Member(email, orgRoles): Promise<null> Parameters
- email: string
- orgRoles: OrganizationRole[]
Returns Promise<null>
Description
Add a member. See the API Documentation for more details.
-
create
- create
Secret(__namedParameters): Promise<null> Parameters
- __namedParameters: {
clusterUuid: string;
secretName: string;
secretValue: string;
}cluster
Uuid: string secret
Name: string secret
Value: string
Returns Promise<null>
Description
Create a new connector secret. See the API Documentation for more details.
-- __namedParameters: {
delete
- delete
Client(clusterUuid, clientId): Promise<null> Parameters
- clusterUuid: string
- clientId: string
Returns Promise<null>
Description
See the API Documentation for more details.
-
delete
- delete
Cluster(clusterUuid): Promise<null> Parameters
- clusterUuid: string
Returns Promise<null>
Description
Delete a cluster. See the API Documentation for more details.
-
delete
- delete
Member(email): Promise<null> Parameters
- email: string
Returns Promise<null>
Description
Delete a member from your organization. See the API Documentation for more details.
-
delete
- delete
Secret(clusterUuid, secretName): Promise<null> Parameters
- clusterUuid: string
- secretName: string
Returns Promise<null>
Description
Delete a connector secret. See the API Documentation for more details.
-
get
- get
Client(clusterUuid, clientId): Promise<ClusterClientConnectionDetails> Parameters
- clusterUuid: string
- clientId: string
Returns Promise<ClusterClientConnectionDetails>
Description
Get the details of an API client. See the API Documentation for more details.
-
get
- get
Clients(clusterUuid): Promise<ClusterClient[]> Parameters
- clusterUuid: string
The cluster UUID
-
Returns Promise<ClusterClient[]>
Description
Get an array of the current API clients for this cluster. See the API Documentation for more details.
-- clusterUuid: string
get
- get
Cluster(clusterUuid): Promise<Cluster> Parameters
- clusterUuid: string
Returns Promise<Cluster>
Description
Retrieve the metadata for a cluster. See the API Documentation for more details.
-
get
- get
Clusters(): Promise<Cluster[]> Returns Promise<Cluster[]>
Description
Return an array of clusters. See the API Documentation for more details.
-
Private get
get
- get
Parameters(): Promise<Parameters> Returns Promise<Parameters>
Description
Retrieve the available parameters for cluster creation. See the API Documentation for more details.
-
get
- get
Secrets(clusterUuid): Promise<{
[key: string]: string;
}> Parameters
- clusterUuid: string
Returns Promise<{
[key: string]: string;
}>Description
Retrieve the connector secrets. See the API Documentation for more details.
-
get
- get
Users(): Promise<Member[]> Returns Promise<Member[]>
Description
Retrieve a list of members and pending invites for your organisation. See the API Documentation for more details.
-
whitelistIPs
- whitelistIPs(clusterUuid, ipwhitelist): Promise<unknown>
Parameters
- clusterUuid: string
- ipwhitelist: [{
description: string;
ip: string;
}]
Returns Promise<unknown>
Description
Add one or more IPs to the whitelist for the cluster. See the API Documentation for more details.
-
Generated using TypeDoc
Class NullAuthProvider
Implements
Index
Constructors
Methods
get
Constructors
constructor
- new
Null Auth Provider(): NullAuthProvider Returns NullAuthProvider
Methods
get
- get
Token(audience): Promise<string> Parameters
- audience: TokenGrantAudienceType
Returns Promise<string>
Generated using TypeDoc
Class OAuthProvider
Implements
Index
Constructors
Properties
audience
Methods
Constructors
constructor
- new OAuth
Provider(options?): OAuthProvider Parameters
Optionaloptions: {
config?: DeepPartial<{
CAMUNDA_CONSOLE_BASE_URL: undefined | string;
CAMUNDA_CONSOLE_CLIENT_ID: undefined | string;
CAMUNDA_CONSOLE_CLIENT_SECRET: undefined | string;
CAMUNDA_CONSOLE_OAUTH_AUDIENCE: string;
CAMUNDA_CUSTOM_CERT_CHAIN_PATH: undefined | string;
CAMUNDA_CUSTOM_PRIVATE_KEY_PATH: undefined | string;
CAMUNDA_CUSTOM_ROOT_CERT_PATH: undefined | string;
CAMUNDA_CUSTOM_USER_AGENT_STRING: undefined | string;
CAMUNDA_MODELER_BASE_URL: string;
CAMUNDA_MODELER_OAUTH_AUDIENCE: undefined | string;
CAMUNDA_OAUTH_DISABLED: boolean;
CAMUNDA_OAUTH_TOKEN_REFRESH_THRESHOLD_MS: number;
CAMUNDA_OAUTH_URL: undefined | string;
CAMUNDA_OPERATE_BASE_URL: undefined | string;
CAMUNDA_OPERATE_OAUTH_AUDIENCE: string;
CAMUNDA_OPTIMIZE_BASE_URL: undefined | string;
CAMUNDA_OPTIMIZE_OAUTH_AUDIENCE: string;
CAMUNDA_SECURE_CONNECTION: boolean;
CAMUNDA_TASKLIST_BASE_URL: undefined | string;
CAMUNDA_TASKLIST_OAUTH_AUDIENCE: string;
CAMUNDA_TENANT_ID: undefined | string;
CAMUNDA_TOKEN_CACHE_DIR: undefined | string;
CAMUNDA_TOKEN_DISK_CACHE_DISABLE: boolean;
CAMUNDA_TOKEN_SCOPE: undefined | string;
CAMUNDA_ZEEBE_OAUTH_AUDIENCE: string;
ZEEBE_ADDRESS: string;
ZEEBE_CLIENT_ID: undefined | string;
ZEEBE_CLIENT_SECRET: undefined | string;
zeebeGrpcSettings: {
GRPC_HTTP2_MAX_PINGS_WITHOUT_DATA: number;
GRPC_HTTP2_MIN_PING_INTERVAL_WITHOUT_DATA_MS: number;
GRPC_HTTP2_MIN_TIME_BETWEEN_PINGS_MS: number;
GRPC_INITIAL_RECONNECT_BACKOFF_MS: string | number;
GRPC_KEEPALIVE_PERMIT_WITHOUT_CALLS: number;
GRPC_KEEPALIVE_TIMEOUT_MS: number;
GRPC_KEEPALIVE_TIME_MS: number;
GRPC_MAX_RECONNECT_BACKOFF_MS: string | number;
GRPC_MIN_RECONNECT_BACKOFF_MS: string | number;
ZEEBE_CLIENT_LOG_LEVEL: string;
ZEEBE_CLIENT_LOG_TYPE: string;
ZEEBE_GRPC_CLIENT_CONNECTION_TOLERANCE_MS: number;
ZEEBE_GRPC_CLIENT_EAGER_CONNECT: boolean;
ZEEBE_GRPC_CLIENT_INITIAL_CONNECTION_TOLERANCE_MS: undefined | number;
ZEEBE_GRPC_CLIENT_MAX_RETRIES: number;
ZEEBE_GRPC_CLIENT_MAX_RETRY_TIMEOUT_SECONDS: number;
ZEEBE_GRPC_CLIENT_RETRY: boolean;
ZEEBE_GRPC_WORKER_LONGPOLL_SECONDS: number;
ZEEBE_GRPC_WORKER_POLL_INTERVAL_MS: number;
};
}>;
}Optionalconfig?: DeepPartial<{
CAMUNDA_CONSOLE_BASE_URL: undefined | string;
CAMUNDA_CONSOLE_CLIENT_ID: undefined | string;
CAMUNDA_CONSOLE_CLIENT_SECRET: undefined | string;
CAMUNDA_CONSOLE_OAUTH_AUDIENCE: string;
CAMUNDA_CUSTOM_CERT_CHAIN_PATH: undefined | string;
CAMUNDA_CUSTOM_PRIVATE_KEY_PATH: undefined | string;
CAMUNDA_CUSTOM_ROOT_CERT_PATH: undefined | string;
CAMUNDA_CUSTOM_USER_AGENT_STRING: undefined | string;
CAMUNDA_MODELER_BASE_URL: string;
CAMUNDA_MODELER_OAUTH_AUDIENCE: undefined | string;
CAMUNDA_OAUTH_DISABLED: boolean;
CAMUNDA_OAUTH_TOKEN_REFRESH_THRESHOLD_MS: number;
CAMUNDA_OAUTH_URL: undefined | string;
CAMUNDA_OPERATE_BASE_URL: undefined | string;
CAMUNDA_OPERATE_OAUTH_AUDIENCE: string;
CAMUNDA_OPTIMIZE_BASE_URL: undefined | string;
CAMUNDA_OPTIMIZE_OAUTH_AUDIENCE: string;
CAMUNDA_SECURE_CONNECTION: boolean;
CAMUNDA_TASKLIST_BASE_URL: undefined | string;
CAMUNDA_TASKLIST_OAUTH_AUDIENCE: string;
CAMUNDA_TENANT_ID: undefined | string;
CAMUNDA_TOKEN_CACHE_DIR: undefined | string;
CAMUNDA_TOKEN_DISK_CACHE_DISABLE: boolean;
CAMUNDA_TOKEN_SCOPE: undefined | string;
CAMUNDA_ZEEBE_OAUTH_AUDIENCE: string;
ZEEBE_ADDRESS: string;
ZEEBE_CLIENT_ID: undefined | string;
ZEEBE_CLIENT_SECRET: undefined | string;
zeebeGrpcSettings: {
GRPC_HTTP2_MAX_PINGS_WITHOUT_DATA: number;
GRPC_HTTP2_MIN_PING_INTERVAL_WITHOUT_DATA_MS: number;
GRPC_HTTP2_MIN_TIME_BETWEEN_PINGS_MS: number;
GRPC_INITIAL_RECONNECT_BACKOFF_MS: string | number;
GRPC_KEEPALIVE_PERMIT_WITHOUT_CALLS: number;
GRPC_KEEPALIVE_TIMEOUT_MS: number;
GRPC_KEEPALIVE_TIME_MS: number;
GRPC_MAX_RECONNECT_BACKOFF_MS: string | number;
GRPC_MIN_RECONNECT_BACKOFF_MS: string | number;
ZEEBE_CLIENT_LOG_LEVEL: string;
ZEEBE_CLIENT_LOG_TYPE: string;
ZEEBE_GRPC_CLIENT_CONNECTION_TOLERANCE_MS: number;
ZEEBE_GRPC_CLIENT_EAGER_CONNECT: boolean;
ZEEBE_GRPC_CLIENT_INITIAL_CONNECTION_TOLERANCE_MS: undefined | number;
ZEEBE_GRPC_CLIENT_MAX_RETRIES: number;
ZEEBE_GRPC_CLIENT_MAX_RETRY_TIMEOUT_SECONDS: number;
ZEEBE_GRPC_CLIENT_RETRY: boolean;
ZEEBE_GRPC_WORKER_LONGPOLL_SECONDS: number;
ZEEBE_GRPC_WORKER_POLL_INTERVAL_MS: number;
};
}>
Returns OAuthProvider
Properties
Private audience
audience
CONSOLE: string;
MODELER: string;
OPERATE: string;
OPTIMIZE: string;
TASKLIST: string;
ZEEBE: string;
}
CONSOLE: string;
MODELER: string;
OPERATE: string;
OPTIMIZE: string;
TASKLIST: string;
ZEEBE: string;
}
Type declaration
CONSOLE: string
MODELER: string
OPERATE: string
OPTIMIZE: string
TASKLIST: string
ZEEBE: string
Private auth
auth
Private cache
cache
Private camunda
camunda
Private client
client
Private client
client
Private console
console
Private console
console
Private Optional custom
custom
Private failed
failed: boolean = false
Private failure
failure
Private Optional inflight
inflight
Private is
is
Private scope
scope: undefined | string
token
Type declaration
[key: string]: Token
Private token
token
Private use
use
user
user
Static Private Readonly default
default
Methods
Private add
- add
Audience If Needed(audienceType): string Camunda SaaS needs an audience for a Modeler token request, and Self-Managed does not.
-Parameters
- audienceType: TokenGrantAudienceType
Returns string
Private evict
- evict
From File Cache(__namedParameters): void Parameters
- __namedParameters: {
audienceType: TokenGrantAudienceType;
clientId: string;
}audience
Type: TokenGrantAudienceType client
Id: string
Returns void
- __namedParameters: {
Private evict
- evict
From Memory Cache(audience): void Parameters
- audience: TokenGrantAudienceType
Returns void
flush
flush
Private get
- get
Audience(audience): string Parameters
- audience: TokenGrantAudienceType
Returns string
Private get
- get
Cache Key(audience): string Parameters
- audience: TokenGrantAudienceType
Returns string
Private get
- get
Cached Token File Name(clientId, audience): string Parameters
- clientId: string
- audience: TokenGrantAudienceType
Returns string
get
- get
Token(audienceType): Promise<string> Parameters
- audienceType: TokenGrantAudienceType
Returns Promise<string>
Private is
- is
Expired(token): boolean Parameters
- token: Token
Returns boolean
Private make
- make
Debounced Token Request(__namedParameters): Promise<string> Parameters
- __namedParameters: {
audienceType: TokenGrantAudienceType;
clientIdToUse: string;
clientSecretToUse: string;
}audience
Type: TokenGrantAudienceType client
Id To Use: string client
Secret To Use: string
Returns Promise<string>
- __namedParameters: {
Private retrieve
- retrieve
From File Cache(clientId, audience): null | Token Parameters
- clientId: string
- audience: TokenGrantAudienceType
Returns null | Token
Private send
- send
To File Cache(__namedParameters): void Parameters
- __namedParameters: {
audience: TokenGrantAudienceType;
clientId: string;
token: Token;
}audience: TokenGrantAudienceType
client
Id: string token: Token
Returns void
- __namedParameters: {
Private send
- send
To Memory Cache(__namedParameters): void Parameters
- __namedParameters: {
audience: TokenGrantAudienceType;
token: Token;
}audience: TokenGrantAudienceType
token: Token
Returns void
- __namedParameters: {
Generated using TypeDoc
Class Camunda8
A single point of configuration for all Camunda Platform 8 clients.
-This class is a facade for all the clients in the Camunda Platform 8 SDK.
-Example
import { Camunda8 } from '@camunda8/sdk'
const c8 = new Camunda8()
const zeebe = c8.getZeebeGrpcClient()
const operate = c8.getOperateApiClient()
const optimize = c8.getOptimizeApiClient()
const tasklist = c8.getTasklistApiClient()
const modeler = c8.getModelerApiClient()
const admin = c8.getAdminApiClient()
- Index
Constructors
Properties
Methods
Constructors
constructor
- new
Camunda8(config?): Camunda8 Parameters
- config: DeepPartial<{
CAMUNDA_CONSOLE_BASE_URL: undefined | string;
CAMUNDA_CONSOLE_CLIENT_ID: undefined | string;
CAMUNDA_CONSOLE_CLIENT_SECRET: undefined | string;
CAMUNDA_CONSOLE_OAUTH_AUDIENCE: string;
CAMUNDA_CUSTOM_CERT_CHAIN_PATH: undefined | string;
CAMUNDA_CUSTOM_PRIVATE_KEY_PATH: undefined | string;
CAMUNDA_CUSTOM_ROOT_CERT_PATH: undefined | string;
CAMUNDA_CUSTOM_USER_AGENT_STRING: undefined | string;
CAMUNDA_MODELER_BASE_URL: string;
CAMUNDA_MODELER_OAUTH_AUDIENCE: undefined | string;
CAMUNDA_OAUTH_DISABLED: boolean;
CAMUNDA_OAUTH_TOKEN_REFRESH_THRESHOLD_MS: number;
CAMUNDA_OAUTH_URL: undefined | string;
CAMUNDA_OPERATE_BASE_URL: undefined | string;
CAMUNDA_OPERATE_OAUTH_AUDIENCE: string;
CAMUNDA_OPTIMIZE_BASE_URL: undefined | string;
CAMUNDA_OPTIMIZE_OAUTH_AUDIENCE: string;
CAMUNDA_SECURE_CONNECTION: boolean;
CAMUNDA_TASKLIST_BASE_URL: undefined | string;
CAMUNDA_TASKLIST_OAUTH_AUDIENCE: string;
CAMUNDA_TENANT_ID: undefined | string;
CAMUNDA_TOKEN_CACHE_DIR: undefined | string;
CAMUNDA_TOKEN_DISK_CACHE_DISABLE: boolean;
CAMUNDA_TOKEN_SCOPE: undefined | string;
CAMUNDA_ZEEBE_OAUTH_AUDIENCE: string;
ZEEBE_ADDRESS: string;
ZEEBE_CLIENT_ID: undefined | string;
ZEEBE_CLIENT_SECRET: undefined | string;
zeebeGrpcSettings: {
GRPC_HTTP2_MAX_PINGS_WITHOUT_DATA: number;
GRPC_HTTP2_MIN_PING_INTERVAL_WITHOUT_DATA_MS: number;
GRPC_HTTP2_MIN_TIME_BETWEEN_PINGS_MS: number;
GRPC_INITIAL_RECONNECT_BACKOFF_MS: string | number;
GRPC_KEEPALIVE_PERMIT_WITHOUT_CALLS: number;
GRPC_KEEPALIVE_TIMEOUT_MS: number;
GRPC_KEEPALIVE_TIME_MS: number;
GRPC_MAX_RECONNECT_BACKOFF_MS: string | number;
GRPC_MIN_RECONNECT_BACKOFF_MS: string | number;
ZEEBE_CLIENT_LOG_LEVEL: string;
ZEEBE_CLIENT_LOG_TYPE: string;
ZEEBE_GRPC_CLIENT_CONNECTION_TOLERANCE_MS: number;
ZEEBE_GRPC_CLIENT_EAGER_CONNECT: boolean;
ZEEBE_GRPC_CLIENT_INITIAL_CONNECTION_TOLERANCE_MS: undefined | number;
ZEEBE_GRPC_CLIENT_MAX_RETRIES: number;
ZEEBE_GRPC_CLIENT_MAX_RETRY_TIMEOUT_SECONDS: number;
ZEEBE_GRPC_CLIENT_RETRY: boolean;
ZEEBE_GRPC_WORKER_LONGPOLL_SECONDS: number;
ZEEBE_GRPC_WORKER_POLL_INTERVAL_MS: number;
};
}> = {}
Returns Camunda8
- config: DeepPartial<{
Properties
Private Optional admin
Private configuration
configuration: {
CAMUNDA_CONSOLE_BASE_URL: undefined | string;
CAMUNDA_CONSOLE_CLIENT_ID: undefined | string;
CAMUNDA_CONSOLE_CLIENT_SECRET: undefined | string;
CAMUNDA_CONSOLE_OAUTH_AUDIENCE: string;
CAMUNDA_CUSTOM_CERT_CHAIN_PATH: undefined | string;
CAMUNDA_CUSTOM_PRIVATE_KEY_PATH: undefined | string;
CAMUNDA_CUSTOM_ROOT_CERT_PATH: undefined | string;
CAMUNDA_CUSTOM_USER_AGENT_STRING: undefined | string;
CAMUNDA_MODELER_BASE_URL: string;
CAMUNDA_MODELER_OAUTH_AUDIENCE: undefined | string;
CAMUNDA_OAUTH_DISABLED: boolean;
CAMUNDA_OAUTH_TOKEN_REFRESH_THRESHOLD_MS: number;
CAMUNDA_OAUTH_URL: undefined | string;
CAMUNDA_OPERATE_BASE_URL: undefined | string;
CAMUNDA_OPERATE_OAUTH_AUDIENCE: string;
CAMUNDA_OPTIMIZE_BASE_URL: undefined | string;
CAMUNDA_OPTIMIZE_OAUTH_AUDIENCE: string;
CAMUNDA_SECURE_CONNECTION: boolean;
CAMUNDA_TASKLIST_BASE_URL: undefined | string;
CAMUNDA_TASKLIST_OAUTH_AUDIENCE: string;
CAMUNDA_TENANT_ID: undefined | string;
CAMUNDA_TOKEN_CACHE_DIR: undefined | string;
CAMUNDA_TOKEN_DISK_CACHE_DISABLE: boolean;
CAMUNDA_TOKEN_SCOPE: undefined | string;
CAMUNDA_ZEEBE_OAUTH_AUDIENCE: string;
ZEEBE_ADDRESS: string;
ZEEBE_CLIENT_ID: undefined | string;
ZEEBE_CLIENT_SECRET: undefined | string;
zeebeGrpcSettings: {
GRPC_HTTP2_MAX_PINGS_WITHOUT_DATA: number;
GRPC_HTTP2_MIN_PING_INTERVAL_WITHOUT_DATA_MS: number;
GRPC_HTTP2_MIN_TIME_BETWEEN_PINGS_MS: number;
GRPC_INITIAL_RECONNECT_BACKOFF_MS: string | number;
GRPC_KEEPALIVE_PERMIT_WITHOUT_CALLS: number;
GRPC_KEEPALIVE_TIMEOUT_MS: number;
GRPC_KEEPALIVE_TIME_MS: number;
GRPC_MAX_RECONNECT_BACKOFF_MS: string | number;
GRPC_MIN_RECONNECT_BACKOFF_MS: string | number;
ZEEBE_CLIENT_LOG_LEVEL: string;
ZEEBE_CLIENT_LOG_TYPE: string;
ZEEBE_GRPC_CLIENT_CONNECTION_TOLERANCE_MS: number;
ZEEBE_GRPC_CLIENT_EAGER_CONNECT: boolean;
ZEEBE_GRPC_CLIENT_INITIAL_CONNECTION_TOLERANCE_MS: undefined | number;
ZEEBE_GRPC_CLIENT_MAX_RETRIES: number;
ZEEBE_GRPC_CLIENT_MAX_RETRY_TIMEOUT_SECONDS: number;
ZEEBE_GRPC_CLIENT_RETRY: boolean;
ZEEBE_GRPC_WORKER_LONGPOLL_SECONDS: number;
ZEEBE_GRPC_WORKER_POLL_INTERVAL_MS: number;
};
}
CAMUNDA_CONSOLE_BASE_URL: undefined | string;
CAMUNDA_CONSOLE_CLIENT_ID: undefined | string;
CAMUNDA_CONSOLE_CLIENT_SECRET: undefined | string;
CAMUNDA_CONSOLE_OAUTH_AUDIENCE: string;
CAMUNDA_CUSTOM_CERT_CHAIN_PATH: undefined | string;
CAMUNDA_CUSTOM_PRIVATE_KEY_PATH: undefined | string;
CAMUNDA_CUSTOM_ROOT_CERT_PATH: undefined | string;
CAMUNDA_CUSTOM_USER_AGENT_STRING: undefined | string;
CAMUNDA_MODELER_BASE_URL: string;
CAMUNDA_MODELER_OAUTH_AUDIENCE: undefined | string;
CAMUNDA_OAUTH_DISABLED: boolean;
CAMUNDA_OAUTH_TOKEN_REFRESH_THRESHOLD_MS: number;
CAMUNDA_OAUTH_URL: undefined | string;
CAMUNDA_OPERATE_BASE_URL: undefined | string;
CAMUNDA_OPERATE_OAUTH_AUDIENCE: string;
CAMUNDA_OPTIMIZE_BASE_URL: undefined | string;
CAMUNDA_OPTIMIZE_OAUTH_AUDIENCE: string;
CAMUNDA_SECURE_CONNECTION: boolean;
CAMUNDA_TASKLIST_BASE_URL: undefined | string;
CAMUNDA_TASKLIST_OAUTH_AUDIENCE: string;
CAMUNDA_TENANT_ID: undefined | string;
CAMUNDA_TOKEN_CACHE_DIR: undefined | string;
CAMUNDA_TOKEN_DISK_CACHE_DISABLE: boolean;
CAMUNDA_TOKEN_SCOPE: undefined | string;
CAMUNDA_ZEEBE_OAUTH_AUDIENCE: string;
ZEEBE_ADDRESS: string;
ZEEBE_CLIENT_ID: undefined | string;
ZEEBE_CLIENT_SECRET: undefined | string;
zeebeGrpcSettings: {
GRPC_HTTP2_MAX_PINGS_WITHOUT_DATA: number;
GRPC_HTTP2_MIN_PING_INTERVAL_WITHOUT_DATA_MS: number;
GRPC_HTTP2_MIN_TIME_BETWEEN_PINGS_MS: number;
GRPC_INITIAL_RECONNECT_BACKOFF_MS: string | number;
GRPC_KEEPALIVE_PERMIT_WITHOUT_CALLS: number;
GRPC_KEEPALIVE_TIMEOUT_MS: number;
GRPC_KEEPALIVE_TIME_MS: number;
GRPC_MAX_RECONNECT_BACKOFF_MS: string | number;
GRPC_MIN_RECONNECT_BACKOFF_MS: string | number;
ZEEBE_CLIENT_LOG_LEVEL: string;
ZEEBE_CLIENT_LOG_TYPE: string;
ZEEBE_GRPC_CLIENT_CONNECTION_TOLERANCE_MS: number;
ZEEBE_GRPC_CLIENT_EAGER_CONNECT: boolean;
ZEEBE_GRPC_CLIENT_INITIAL_CONNECTION_TOLERANCE_MS: undefined | number;
ZEEBE_GRPC_CLIENT_MAX_RETRIES: number;
ZEEBE_GRPC_CLIENT_MAX_RETRY_TIMEOUT_SECONDS: number;
ZEEBE_GRPC_CLIENT_RETRY: boolean;
ZEEBE_GRPC_WORKER_LONGPOLL_SECONDS: number;
ZEEBE_GRPC_WORKER_POLL_INTERVAL_MS: number;
};
}
Type declaration
CAMUNDA_
CONSOLE_ BASE_ URL: undefined | string The base url for the Admin Console API.
-CAMUNDA_
CONSOLE_ CLIENT_ ID: undefined | string Credentials for Admin Console and Modeler API
-CAMUNDA_
CONSOLE_ CLIENT_ SECRET: undefined | string Credentials for Admin Console and Modeler API
-CAMUNDA_
CONSOLE_ OAUTH_ AUDIENCE: string The audience parameter for an Admin Console OAuth token request. Defaults to api.cloud.camunda.io when connecting to Camunda SaaS, and '' otherwise
-CAMUNDA_
CUSTOM_ CERT_ CHAIN_ PATH: undefined | string When using custom or self-signed certificates, provide the path to the certificate chain
-CAMUNDA_
CUSTOM_ PRIVATE_ KEY_ PATH: undefined | string When using custom or self-signed certificates, provide the path to the private key
-CAMUNDA_
CUSTOM_ ROOT_ CERT_ PATH: undefined | string In an environment using self-signed certificates, provide the path to the root certificate
-CAMUNDA_
CUSTOM_ USER_ AGENT_ STRING: undefined | string Custom user agent
-CAMUNDA_
MODELER_ BASE_ URL: string The base url for the Modeler API. Defaults to Camunda Saas - https://modeler.cloud.camunda.io/api
-CAMUNDA_
MODELER_ OAUTH_ AUDIENCE: undefined | string The audience parameter for a Modeler OAuth token request. Defaults to api.cloud.camunda.io when connecting to Camunda SaaS, and '' otherwise
-CAMUNDA_
OAUTH_ DISABLED: boolean Set to true to disable OAuth completely
-CAMUNDA_
OAUTH_ TOKEN_ REFRESH_ THRESHOLD_ MS: number How soon in milliseconds before its expiration time a cached OAuth token should be considered expired. Defaults to 1000
-CAMUNDA_
OAUTH_ URL: undefined | string The OAuth token exchange endpoint url
-CAMUNDA_
OPERATE_ BASE_ URL: undefined | string The base url for the Operate API
-CAMUNDA_
OPERATE_ OAUTH_ AUDIENCE: string The audience parameter for an Operate OAuth token request. Defaults to operate.camunda.io
-CAMUNDA_
OPTIMIZE_ BASE_ URL: undefined | string The base url for the Optimize API
-CAMUNDA_
OPTIMIZE_ OAUTH_ AUDIENCE: string The audience parameter for an Optimize OAuth token request. Defaults to optimize.camunda.io
-CAMUNDA_
SECURE_ CONNECTION: boolean Control TLS for Zeebe Grpc. Defaults to true. Set to false when using an unsecured gateway
-CAMUNDA_
TASKLIST_ BASE_ URL: undefined | string The base url for the Tasklist API
-CAMUNDA_
TASKLIST_ OAUTH_ AUDIENCE: string The audience parameter for a Tasklist OAuth token request. Defaults to tasklist.camunda.io
-CAMUNDA_
TENANT_ ID: undefined | string The tenant id when multi-tenancy is enabled
-CAMUNDA_
TOKEN_ CACHE_ DIR: undefined | string The directory to cache OAuth tokens on-disk. Defaults to $HOME/.camunda
-CAMUNDA_
TOKEN_ DISK_ CACHE_ DISABLE: boolean Set to true to disable disk caching of OAuth tokens and use memory caching only
-CAMUNDA_
TOKEN_ SCOPE: undefined | string Optional scope parameter for OAuth (needed by some OIDC)
-CAMUNDA_
ZEEBE_ OAUTH_ AUDIENCE: string The audience parameter for a Zeebe OAuth token request. Defaults to zeebe.camunda.io
-ZEEBE_
ADDRESS: string The address for the Zeebe Gateway. Defaults to localhost:26500
-ZEEBE_
CLIENT_ ID: undefined | string This is the client ID for the client credentials
-ZEEBE_
CLIENT_ SECRET: undefined | string This is the client secret for the client credentials
-zeebe
Grpc Settings: {
GRPC_HTTP2_MAX_PINGS_WITHOUT_DATA: number;
GRPC_HTTP2_MIN_PING_INTERVAL_WITHOUT_DATA_MS: number;
GRPC_HTTP2_MIN_TIME_BETWEEN_PINGS_MS: number;
GRPC_INITIAL_RECONNECT_BACKOFF_MS: string | number;
GRPC_KEEPALIVE_PERMIT_WITHOUT_CALLS: number;
GRPC_KEEPALIVE_TIMEOUT_MS: number;
GRPC_KEEPALIVE_TIME_MS: number;
GRPC_MAX_RECONNECT_BACKOFF_MS: string | number;
GRPC_MIN_RECONNECT_BACKOFF_MS: string | number;
ZEEBE_CLIENT_LOG_LEVEL: string;
ZEEBE_CLIENT_LOG_TYPE: string;
ZEEBE_GRPC_CLIENT_CONNECTION_TOLERANCE_MS: number;
ZEEBE_GRPC_CLIENT_EAGER_CONNECT: boolean;
ZEEBE_GRPC_CLIENT_INITIAL_CONNECTION_TOLERANCE_MS: undefined | number;
ZEEBE_GRPC_CLIENT_MAX_RETRIES: number;
ZEEBE_GRPC_CLIENT_MAX_RETRY_TIMEOUT_SECONDS: number;
ZEEBE_GRPC_CLIENT_RETRY: boolean;
ZEEBE_GRPC_WORKER_LONGPOLL_SECONDS: number;
ZEEBE_GRPC_WORKER_POLL_INTERVAL_MS: number;
}GRPC_
HTTP2_ MAX_ PINGS_ WITHOUT_ DATA: number This channel argument controls the maximum number -of pings that can be sent when there is no other -data (data frame or header frame) to be sent. -GRPC Core will not continue sending pings if we -run over the limit. Setting it to 0 allows sending -pings without sending data.
-GRPC_
HTTP2_ MIN_ PING_ INTERVAL_ WITHOUT_ DATA_ MS: number Minimum allowed time between a server receiving -successive ping frames without sending any data -frame. Int valued, milliseconds. Default: 90000
-GRPC_
HTTP2_ MIN_ TIME_ BETWEEN_ PINGS_ MS: number Defaults to 90000.
-GRPC_
INITIAL_ RECONNECT_ BACKOFF_ MS: string | number The time between the first and second connection attempts, -in ms. Defaults to 1000.
-GRPC_
KEEPALIVE_ PERMIT_ WITHOUT_ CALLS: number This channel argument if set to 1 -(0 : false; 1 : true), allows keepalive pings -to be sent even if there are no calls in flight. -Defaults to 1.
-GRPC_
KEEPALIVE_ TIMEOUT_ MS: number After waiting for a duration of this time, if the keepalive ping sender does not receive the ping ack, it will close the -transport. Int valued, milliseconds. Defaults to 120000.
-GRPC_
KEEPALIVE_ TIME_ MS: number After a duration of this time the client/server pings its peer to see if the transport is still alive. -Int valued, milliseconds. Defaults to 360000.
-GRPC_
MAX_ RECONNECT_ BACKOFF_ MS: string | number The maximum time between subsequent connection attempts, -in ms. Defaults to 10000.
-GRPC_
MIN_ RECONNECT_ BACKOFF_ MS: string | number The minimum time between subsequent connection attempts, -in ms. Default is 1000ms, but this can cause an SSL Handshake failure. -This causes an intermittent failure in the Worker-LongPoll test when run -against Camunda Cloud. -Raised to 5000ms. -See: https://github.com/grpc/grpc/issues/8382#issuecomment-259482949
-ZEEBE_
CLIENT_ LOG_ LEVEL: string Log level of Zeebe Client and Workers - 'DEBUG' | 'INFO' | 'NONE'. Defaults to 'INFO'
-ZEEBE_
CLIENT_ LOG_ TYPE: string Zeebe client log output can be human-readable 'SIMPLE' or structured 'JSON'. Defaults to 'SIMPLE'
-ZEEBE_
GRPC_ CLIENT_ CONNECTION_ TOLERANCE_ MS: number The gRPC channel can "jitter". This suppresses a connection error message if the channel comes back within this window in milliseconds. Defaults to 3000
-ZEEBE_
GRPC_ CLIENT_ EAGER_ CONNECT: boolean Immediately connect to the Zeebe Gateway (issues a silent topology request). Defaults to false
-ZEEBE_
GRPC_ CLIENT_ INITIAL_ CONNECTION_ TOLERANCE_ MS: undefined | number This suppresses intermediate errors during initial connection negotiation. On Camunda SaaS this defaults to 6000, on Self-Managed to 0
-ZEEBE_
GRPC_ CLIENT_ MAX_ RETRIES: number Maximum number of retries of network operations before failing. Defaults to -1 (infinite retries)
-ZEEBE_
GRPC_ CLIENT_ MAX_ RETRY_ TIMEOUT_ SECONDS: number When retrying failed network operations, retries back off to this maximum period. Defaults to 10s
-ZEEBE_
GRPC_ CLIENT_ RETRY: boolean Automate retrying operations that fail due to network conditions or broker backpressure. Defaults to true
-ZEEBE_
GRPC_ WORKER_ LONGPOLL_ SECONDS: number How long in seconds the long poll Job Activation request is held open by a worker. Defaults to 60
-ZEEBE_
GRPC_ WORKER_ POLL_ INTERVAL_ MS: number After a long poll Job Activation request, this is the cool-off period in milliseconds before the worker requests more work. Defaults to 300
-
Private Optional modeler
Private o
Private Optional operate
Private Optional optimize
Private Optional tasklist
Private Optional zeebe
Methods
get
- get
Admin Api Client(): AdminApiClient Returns AdminApiClient
get
- get
Modeler Api Client(): ModelerApiClient Returns ModelerApiClient
get
- get
Operate Api Client(): OperateApiClient Returns OperateApiClient
get
- get
Optimize Api Client(): OptimizeApiClient Returns OptimizeApiClient
get
- get
Tasklist Api Client(): TasklistApiClient Returns TasklistApiClient
get
- get
Zeebe Api Client(): ZeebeGrpcClient Returns ZeebeGrpcClient
Generated using TypeDoc
Class ModelerApiClient
Index
Constructors
Properties
Methods
add
Constructors
constructor
- new
Modeler Api Client(options?): ModelerApiClient Parameters
Optionaloptions: {
config?: DeepPartial<{
CAMUNDA_CONSOLE_BASE_URL: undefined | string;
CAMUNDA_CONSOLE_CLIENT_ID: undefined | string;
CAMUNDA_CONSOLE_CLIENT_SECRET: undefined | string;
CAMUNDA_CONSOLE_OAUTH_AUDIENCE: string;
CAMUNDA_CUSTOM_CERT_CHAIN_PATH: undefined | string;
CAMUNDA_CUSTOM_PRIVATE_KEY_PATH: undefined | string;
CAMUNDA_CUSTOM_ROOT_CERT_PATH: undefined | string;
CAMUNDA_CUSTOM_USER_AGENT_STRING: undefined | string;
CAMUNDA_MODELER_BASE_URL: string;
CAMUNDA_MODELER_OAUTH_AUDIENCE: undefined | string;
CAMUNDA_OAUTH_DISABLED: boolean;
CAMUNDA_OAUTH_TOKEN_REFRESH_THRESHOLD_MS: number;
CAMUNDA_OAUTH_URL: undefined | string;
CAMUNDA_OPERATE_BASE_URL: undefined | string;
CAMUNDA_OPERATE_OAUTH_AUDIENCE: string;
CAMUNDA_OPTIMIZE_BASE_URL: undefined | string;
CAMUNDA_OPTIMIZE_OAUTH_AUDIENCE: string;
CAMUNDA_SECURE_CONNECTION: boolean;
CAMUNDA_TASKLIST_BASE_URL: undefined | string;
CAMUNDA_TASKLIST_OAUTH_AUDIENCE: string;
CAMUNDA_TENANT_ID: undefined | string;
CAMUNDA_TOKEN_CACHE_DIR: undefined | string;
CAMUNDA_TOKEN_DISK_CACHE_DISABLE: boolean;
CAMUNDA_TOKEN_SCOPE: undefined | string;
CAMUNDA_ZEEBE_OAUTH_AUDIENCE: string;
ZEEBE_ADDRESS: string;
ZEEBE_CLIENT_ID: undefined | string;
ZEEBE_CLIENT_SECRET: undefined | string;
zeebeGrpcSettings: {
GRPC_HTTP2_MAX_PINGS_WITHOUT_DATA: number;
GRPC_HTTP2_MIN_PING_INTERVAL_WITHOUT_DATA_MS: number;
GRPC_HTTP2_MIN_TIME_BETWEEN_PINGS_MS: number;
GRPC_INITIAL_RECONNECT_BACKOFF_MS: string | number;
GRPC_KEEPALIVE_PERMIT_WITHOUT_CALLS: number;
GRPC_KEEPALIVE_TIMEOUT_MS: number;
GRPC_KEEPALIVE_TIME_MS: number;
GRPC_MAX_RECONNECT_BACKOFF_MS: string | number;
GRPC_MIN_RECONNECT_BACKOFF_MS: string | number;
ZEEBE_CLIENT_LOG_LEVEL: string;
ZEEBE_CLIENT_LOG_TYPE: string;
ZEEBE_GRPC_CLIENT_CONNECTION_TOLERANCE_MS: number;
ZEEBE_GRPC_CLIENT_EAGER_CONNECT: boolean;
ZEEBE_GRPC_CLIENT_INITIAL_CONNECTION_TOLERANCE_MS: undefined | number;
ZEEBE_GRPC_CLIENT_MAX_RETRIES: number;
ZEEBE_GRPC_CLIENT_MAX_RETRY_TIMEOUT_SECONDS: number;
ZEEBE_GRPC_CLIENT_RETRY: boolean;
ZEEBE_GRPC_WORKER_LONGPOLL_SECONDS: number;
ZEEBE_GRPC_WORKER_POLL_INTERVAL_MS: number;
};
}>;
oAuthProvider?: IOAuthProvider;
}Optionalconfig?: DeepPartial<{
CAMUNDA_CONSOLE_BASE_URL: undefined | string;
CAMUNDA_CONSOLE_CLIENT_ID: undefined | string;
CAMUNDA_CONSOLE_CLIENT_SECRET: undefined | string;
CAMUNDA_CONSOLE_OAUTH_AUDIENCE: string;
CAMUNDA_CUSTOM_CERT_CHAIN_PATH: undefined | string;
CAMUNDA_CUSTOM_PRIVATE_KEY_PATH: undefined | string;
CAMUNDA_CUSTOM_ROOT_CERT_PATH: undefined | string;
CAMUNDA_CUSTOM_USER_AGENT_STRING: undefined | string;
CAMUNDA_MODELER_BASE_URL: string;
CAMUNDA_MODELER_OAUTH_AUDIENCE: undefined | string;
CAMUNDA_OAUTH_DISABLED: boolean;
CAMUNDA_OAUTH_TOKEN_REFRESH_THRESHOLD_MS: number;
CAMUNDA_OAUTH_URL: undefined | string;
CAMUNDA_OPERATE_BASE_URL: undefined | string;
CAMUNDA_OPERATE_OAUTH_AUDIENCE: string;
CAMUNDA_OPTIMIZE_BASE_URL: undefined | string;
CAMUNDA_OPTIMIZE_OAUTH_AUDIENCE: string;
CAMUNDA_SECURE_CONNECTION: boolean;
CAMUNDA_TASKLIST_BASE_URL: undefined | string;
CAMUNDA_TASKLIST_OAUTH_AUDIENCE: string;
CAMUNDA_TENANT_ID: undefined | string;
CAMUNDA_TOKEN_CACHE_DIR: undefined | string;
CAMUNDA_TOKEN_DISK_CACHE_DISABLE: boolean;
CAMUNDA_TOKEN_SCOPE: undefined | string;
CAMUNDA_ZEEBE_OAUTH_AUDIENCE: string;
ZEEBE_ADDRESS: string;
ZEEBE_CLIENT_ID: undefined | string;
ZEEBE_CLIENT_SECRET: undefined | string;
zeebeGrpcSettings: {
GRPC_HTTP2_MAX_PINGS_WITHOUT_DATA: number;
GRPC_HTTP2_MIN_PING_INTERVAL_WITHOUT_DATA_MS: number;
GRPC_HTTP2_MIN_TIME_BETWEEN_PINGS_MS: number;
GRPC_INITIAL_RECONNECT_BACKOFF_MS: string | number;
GRPC_KEEPALIVE_PERMIT_WITHOUT_CALLS: number;
GRPC_KEEPALIVE_TIMEOUT_MS: number;
GRPC_KEEPALIVE_TIME_MS: number;
GRPC_MAX_RECONNECT_BACKOFF_MS: string | number;
GRPC_MIN_RECONNECT_BACKOFF_MS: string | number;
ZEEBE_CLIENT_LOG_LEVEL: string;
ZEEBE_CLIENT_LOG_TYPE: string;
ZEEBE_GRPC_CLIENT_CONNECTION_TOLERANCE_MS: number;
ZEEBE_GRPC_CLIENT_EAGER_CONNECT: boolean;
ZEEBE_GRPC_CLIENT_INITIAL_CONNECTION_TOLERANCE_MS: undefined | number;
ZEEBE_GRPC_CLIENT_MAX_RETRIES: number;
ZEEBE_GRPC_CLIENT_MAX_RETRY_TIMEOUT_SECONDS: number;
ZEEBE_GRPC_CLIENT_RETRY: boolean;
ZEEBE_GRPC_WORKER_LONGPOLL_SECONDS: number;
ZEEBE_GRPC_WORKER_POLL_INTERVAL_MS: number;
};
}>OptionaloAuth Provider?: IOAuthProvider
Returns ModelerApiClient
Properties
Private o
Private rest
rest: Got
Private user
user
Methods
add
- add
Collaborator(req): Promise<null> Adds a new collaborator to a project or modifies the permission level of an existing collaborator. -Note: Only users that are part of the authorized organization (see GET /api/v1/info) and logged in to Web Modeler at least once can be added to a project.
-Parameters
Returns Promise<null>
create
- create
File(req): Promise<FileMetadataDto> This endpoint creates a file.
-To create a file, specify projectId and/or folderId:
-When only folderId is given, the file will be created in that folder. The folder can be in any project of the same organization.
-When projectId is given and folderId is either null or omitted altogether, the file will be created in the root of the project.
-When projectId and folderId are both given, they must be consistent - i.e. the folder is in the project.
-For connector templates, the following constraints apply:
-The value of content.$schema will be replaced with https://unpkg.com/@camunda/zeebe-element-templates-json-schema/resources/schema.json and validated against it.
-The value of name takes precedence over content.name. In case of mismatch, the latter will be adjusted to match the former automatically.
-The value of content.id will be replaced with the file id generated by Web Modeler.
-The value of content.version is managed by Web Modeler and will be updated automatically.
-Note: The simplePath transforms any occurrences of slashes ("/") in file and folder names into an escape sequence consisting of a backslash followed by a slash ("/"). This form of escaping facilitates the processing of path-like structures within file and folder names.
-Parameters
- req: CreateFileDto
Returns Promise<FileMetadataDto>
create
- create
Folder(req): Promise<FolderMetadataDto> Creates a new folder.
-When only parentId is given, the folder will be created in that folder. The folder can be in any project of the same organization.
-When projectId is given and parentId is either null or omitted altogether, the folder will be created in the root of the project.
-When projectId and parentId are both given, they must be consistent - i.e. the parent folder is in the project.
-Parameters
- req: CreateFolderDto
Returns Promise<FolderMetadataDto>
create
- create
Milestone(req): Promise<MilestoneMetadataDto> Parameters
- req: CreateMilestoneDto
Returns Promise<MilestoneMetadataDto>
create
- create
Project(name): Promise<ProjectMetadataDto> Creates a new project. This project will be created without any collaborators, so it will not be visible in the UI by default. To assign collaborators, use
-addCollaborator().Parameters
- name: string
Returns Promise<ProjectMetadataDto>
Private decode
delete
delete
- delete
File(fileId): Promise<null> Deletes a file. -Note: Deleting a file will also delete other resources attached to the file (comments, call activity/business rule task links, milestones and shares) which might have side-effects. Deletion of resources is recursive and cannot be undone.
-Parameters
- fileId: string
Returns Promise<null>
delete
delete
delete
get
- get
File(fileId): Promise<FileDto> Retrieves a file.
-Note: The simplePath transforms any occurrences of slashes ("/") in file and folder names into an -escape sequence consisting of a backslash followed by a slash ("/"). This form of escaping -facilitates the processing of path-like structures within file and folder names.
-Does this throw if it is not found?
-Parameters
- fileId: string
Returns Promise<FileDto>
get
Private get
get
get
- get
Milestone(milestoneId): Promise<MilestoneDto> Parameters
- milestoneId: string
Returns Promise<MilestoneDto>
get
- get
Milestone Comparison(milestone1Id, milestone2Id): Promise<string> Returns a link to a visual comparison between two milestones where the milestone referenced by milestone1Id acts as a baseline to compare the milestone referenced by milestone2Id against.
-Parameters
- milestone1Id: string
- milestone2Id: string
Returns Promise<string>
get
- get
Project(projectId): Promise<ProjectDto> Parameters
- projectId: string
Returns Promise<ProjectDto>
rename
- rename
Project(projectId, name): Promise<ProjectMetadataDto> Parameters
- projectId: string
- name: string
Returns Promise<ProjectMetadataDto>
search
- search
Collaborators(req): Promise<PubSearchResultDtoProjectCollaboratorDto> Searches for collaborators. -filter specifies which fields should match. Only items that match the given fields will be returned. -sort specifies by which fields and direction (ASC/DESC) the result should be sorted. -page specifies the page number to return. -size specifies the number of items per page. The default value is 10.
-Parameters
Returns Promise<PubSearchResultDtoProjectCollaboratorDto>
search
- search
Files(req): Promise<PubSearchResultDtoFileMetadataDto> Searches for files. -filter specifies which fields should match. Only items that match the given fields will be returned.
-Note: Date fields need to be specified in a format compatible with java.time.ZonedDateTime; for example 2023-09-20T11:31:20.206801604Z.
-You can use suffixes to match date ranges:
-Modifier Description -||/y Within a year -||/M Within a month -||/w Within a week -||/d Within a day -||/h Within an hour -||/m Within a minute -||/s Within a second
-sort specifies by which fields and direction (ASC/DESC) the result should be sorted.
-page specifies the page number to return. -size specifies the number of items per page. The default value is 10.
-Note: The simplePath transform any occurrences of slashes ("/") in file and folder names into an escape sequence consisting of a backslash followed by a slash ("/"). This form of escaping facilitates the processing of path-like structures within file and folder names.
-Parameters
Returns Promise<PubSearchResultDtoFileMetadataDto>
search
- search
Milestones(req): Promise<PubSearchResultDtoMilestoneMetadataDto> Searches for milestones.
-filter specifies which fields should match. Only items that match the given fields will be returned.
-Note: Date fields need to be specified in a format compatible with java.time.ZonedDateTime; for example 2023-09-20T11:31:20.206801604Z.
-You can use suffixes to match date ranges:
-Modifier Description -||/y Within a year -||/M Within a month -||/w Within a week -||/d Within a day -||/h Within an hour -||/m Within a minute -||/s Within a second -sort specifies by which fields and direction (ASC/DESC) the result should be sorted.
-page specifies the page number to return.
-size specifies the number of items per page. The default value is 10.
-Parameters
Returns Promise<PubSearchResultDtoMilestoneMetadataDto>
search
- search
Projects(req): Promise<PubSearchResultDtoProjectMetadataDto> Searches for projects.
-filter specifies which fields should match. Only items that match the given fields will be returned.
-Note: Date fields need to be specified in a format compatible with java.time.ZonedDateTime; for example 2023-09-20T11:31:20.206801604Z.
-You can use suffixes to match date ranges:
-Modifier Description -||/y Within a year -||/M Within a month -||/w Within a week -||/d Within a day -||/h Within an hour -||/m Within a minute -||/s Within a second
-sort specifies by which fields and direction (ASC/DESC) the result should be sorted.
-page specifies the page number to return.
-size specifies the number of items per page. The default value is 10.
-Parameters
Returns Promise<PubSearchResultDtoProjectMetadataDto>
update
- update
File(fileId, update): Promise<FileMetadataDto> Updates the content, name, or location of a file, or all at the same time.
-To move a file, specify projectId and/or folderId: -When only folderId is given, the file will be moved to that folder. The folder can be in another project of the same organization. -When projectId is given and folderId is either null or omitted altogether, the file will be moved to the root of the project. -When projectId and folderId are both given, they must be consistent - i.e. the new parent folder is in the new project. -The field revision holds the current revision of the file. This is used for detecting and preventing concurrent modifications. -For connector templates, the following constraints apply: -The value of content.$schema is not updatable. -The value of content.name can only be changed via name. -The value of content.id is not updatable. -The value of content.version is managed by Web Modeler and will be updated automatically. -Note: The simplePath transforms any occurrences of slashes ("/") in file and folder names into an escape sequence consisting of a backslash followed by a slash ("/"). This form of escaping facilitates the processing of path-like structures within file and folder names.
-Parameters
- fileId: string
- update: UpdateFileDto
Returns Promise<FileMetadataDto>
update
- update
Folder(folderId, update): Promise<FolderMetadataDto> Updates the name or location of a folder, or both at the same time.
-To move a folder, specify projectId and/or parentId:
-When only parentId is given, the file will be moved to that folder. The folder must keep in the same organization.
-When projectId is given and parentId is either null or omitted altogether, the file will be moved to the root of the project.
-When projectId and parentId are both given, they must be consistent - i.e. the new parent folder is in the new project.
-Parameters
- folderId: string
- update: UpdateFolderDto
Returns Promise<FolderMetadataDto>
Generated using TypeDoc
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)
})
- Index
Constructors
Properties
Methods
add
Constructors
constructor
- new
Operate Api Client(options?): OperateApiClient Parameters
Optionaloptions: {
config?: DeepPartial<{
CAMUNDA_CONSOLE_BASE_URL: undefined | string;
CAMUNDA_CONSOLE_CLIENT_ID: undefined | string;
CAMUNDA_CONSOLE_CLIENT_SECRET: undefined | string;
CAMUNDA_CONSOLE_OAUTH_AUDIENCE: string;
CAMUNDA_CUSTOM_CERT_CHAIN_PATH: undefined | string;
CAMUNDA_CUSTOM_PRIVATE_KEY_PATH: undefined | string;
CAMUNDA_CUSTOM_ROOT_CERT_PATH: undefined | string;
CAMUNDA_CUSTOM_USER_AGENT_STRING: undefined | string;
CAMUNDA_MODELER_BASE_URL: string;
CAMUNDA_MODELER_OAUTH_AUDIENCE: undefined | string;
CAMUNDA_OAUTH_DISABLED: boolean;
CAMUNDA_OAUTH_TOKEN_REFRESH_THRESHOLD_MS: number;
CAMUNDA_OAUTH_URL: undefined | string;
CAMUNDA_OPERATE_BASE_URL: undefined | string;
CAMUNDA_OPERATE_OAUTH_AUDIENCE: string;
CAMUNDA_OPTIMIZE_BASE_URL: undefined | string;
CAMUNDA_OPTIMIZE_OAUTH_AUDIENCE: string;
CAMUNDA_SECURE_CONNECTION: boolean;
CAMUNDA_TASKLIST_BASE_URL: undefined | string;
CAMUNDA_TASKLIST_OAUTH_AUDIENCE: string;
CAMUNDA_TENANT_ID: undefined | string;
CAMUNDA_TOKEN_CACHE_DIR: undefined | string;
CAMUNDA_TOKEN_DISK_CACHE_DISABLE: boolean;
CAMUNDA_TOKEN_SCOPE: undefined | string;
CAMUNDA_ZEEBE_OAUTH_AUDIENCE: string;
ZEEBE_ADDRESS: string;
ZEEBE_CLIENT_ID: undefined | string;
ZEEBE_CLIENT_SECRET: undefined | string;
zeebeGrpcSettings: {
GRPC_HTTP2_MAX_PINGS_WITHOUT_DATA: number;
GRPC_HTTP2_MIN_PING_INTERVAL_WITHOUT_DATA_MS: number;
GRPC_HTTP2_MIN_TIME_BETWEEN_PINGS_MS: number;
GRPC_INITIAL_RECONNECT_BACKOFF_MS: string | number;
GRPC_KEEPALIVE_PERMIT_WITHOUT_CALLS: number;
GRPC_KEEPALIVE_TIMEOUT_MS: number;
GRPC_KEEPALIVE_TIME_MS: number;
GRPC_MAX_RECONNECT_BACKOFF_MS: string | number;
GRPC_MIN_RECONNECT_BACKOFF_MS: string | number;
ZEEBE_CLIENT_LOG_LEVEL: string;
ZEEBE_CLIENT_LOG_TYPE: string;
ZEEBE_GRPC_CLIENT_CONNECTION_TOLERANCE_MS: number;
ZEEBE_GRPC_CLIENT_EAGER_CONNECT: boolean;
ZEEBE_GRPC_CLIENT_INITIAL_CONNECTION_TOLERANCE_MS: undefined | number;
ZEEBE_GRPC_CLIENT_MAX_RETRIES: number;
ZEEBE_GRPC_CLIENT_MAX_RETRY_TIMEOUT_SECONDS: number;
ZEEBE_GRPC_CLIENT_RETRY: boolean;
ZEEBE_GRPC_WORKER_LONGPOLL_SECONDS: number;
ZEEBE_GRPC_WORKER_POLL_INTERVAL_MS: number;
};
}>;
oAuthProvider?: IOAuthProvider;
}Optionalconfig?: DeepPartial<{
CAMUNDA_CONSOLE_BASE_URL: undefined | string;
CAMUNDA_CONSOLE_CLIENT_ID: undefined | string;
CAMUNDA_CONSOLE_CLIENT_SECRET: undefined | string;
CAMUNDA_CONSOLE_OAUTH_AUDIENCE: string;
CAMUNDA_CUSTOM_CERT_CHAIN_PATH: undefined | string;
CAMUNDA_CUSTOM_PRIVATE_KEY_PATH: undefined | string;
CAMUNDA_CUSTOM_ROOT_CERT_PATH: undefined | string;
CAMUNDA_CUSTOM_USER_AGENT_STRING: undefined | string;
CAMUNDA_MODELER_BASE_URL: string;
CAMUNDA_MODELER_OAUTH_AUDIENCE: undefined | string;
CAMUNDA_OAUTH_DISABLED: boolean;
CAMUNDA_OAUTH_TOKEN_REFRESH_THRESHOLD_MS: number;
CAMUNDA_OAUTH_URL: undefined | string;
CAMUNDA_OPERATE_BASE_URL: undefined | string;
CAMUNDA_OPERATE_OAUTH_AUDIENCE: string;
CAMUNDA_OPTIMIZE_BASE_URL: undefined | string;
CAMUNDA_OPTIMIZE_OAUTH_AUDIENCE: string;
CAMUNDA_SECURE_CONNECTION: boolean;
CAMUNDA_TASKLIST_BASE_URL: undefined | string;
CAMUNDA_TASKLIST_OAUTH_AUDIENCE: string;
CAMUNDA_TENANT_ID: undefined | string;
CAMUNDA_TOKEN_CACHE_DIR: undefined | string;
CAMUNDA_TOKEN_DISK_CACHE_DISABLE: boolean;
CAMUNDA_TOKEN_SCOPE: undefined | string;
CAMUNDA_ZEEBE_OAUTH_AUDIENCE: string;
ZEEBE_ADDRESS: string;
ZEEBE_CLIENT_ID: undefined | string;
ZEEBE_CLIENT_SECRET: undefined | string;
zeebeGrpcSettings: {
GRPC_HTTP2_MAX_PINGS_WITHOUT_DATA: number;
GRPC_HTTP2_MIN_PING_INTERVAL_WITHOUT_DATA_MS: number;
GRPC_HTTP2_MIN_TIME_BETWEEN_PINGS_MS: number;
GRPC_INITIAL_RECONNECT_BACKOFF_MS: string | number;
GRPC_KEEPALIVE_PERMIT_WITHOUT_CALLS: number;
GRPC_KEEPALIVE_TIMEOUT_MS: number;
GRPC_KEEPALIVE_TIME_MS: number;
GRPC_MAX_RECONNECT_BACKOFF_MS: string | number;
GRPC_MIN_RECONNECT_BACKOFF_MS: string | number;
ZEEBE_CLIENT_LOG_LEVEL: string;
ZEEBE_CLIENT_LOG_TYPE: string;
ZEEBE_GRPC_CLIENT_CONNECTION_TOLERANCE_MS: number;
ZEEBE_GRPC_CLIENT_EAGER_CONNECT: boolean;
ZEEBE_GRPC_CLIENT_INITIAL_CONNECTION_TOLERANCE_MS: undefined | number;
ZEEBE_GRPC_CLIENT_MAX_RETRIES: number;
ZEEBE_GRPC_CLIENT_MAX_RETRY_TIMEOUT_SECONDS: number;
ZEEBE_GRPC_CLIENT_RETRY: boolean;
ZEEBE_GRPC_WORKER_LONGPOLL_SECONDS: number;
ZEEBE_GRPC_WORKER_POLL_INTERVAL_MS: number;
};
}>OptionaloAuth Provider?: IOAuthProvider
Returns OperateApiClient
Example
-const operate = new OperateApiClient() -
Properties
Private o
Private rest
rest: Got
Private tenant
tenant
Private user
user
Methods
Protected add
- add
Tenant Id To Filter<T>(query, tenantId?): Query<EnhanceWithTenantIdIfMissing<T>> Type Parameters
Returns Query<EnhanceWithTenantIdIfMissing<T>>
delete
- delete
Process Instance(processInstanceKey): Promise<ChangeStatus> Parameters
- processInstanceKey: string | number
Returns Promise<ChangeStatus>
Description
Delete a specific process instance by key.
-Example
-const operate = new OperateApiClient()
await operate.deleteProcessInstance(2251799819847322) -
get
- get
Decision Definition(decisionDefinitionKey): Promise<DecisionDefinition> Parameters
- decisionDefinitionKey: string | number
Returns Promise<DecisionDefinition>
get
- get
Decision Instance(decisionInstanceKey): Promise<DecisionInstance> Parameters
- decisionInstanceKey: string | number
Returns Promise<DecisionInstance>
get
- get
Decision Requirements(key): Promise<DecisionRequirements> Parameters
- key: string | number
Returns Promise<DecisionRequirements>
get
get
- get
Flownode Instance(key): Promise<FlownodeInstance> Parameters
- key: string | number
Returns Promise<FlownodeInstance>
Private get
get
getJSONVariablesfor
get
- get
Process Definition(processDefinitionKey): Promise<ProcessDefinition> Parameters
- processDefinitionKey: string | number
Returns Promise<ProcessDefinition>
Description
Retrieve the metadata for a specific process definition, by key.
- -Example
-const operate = new OperateApiClient()
const definition = await operate.getProcessDefinition(2251799817140074); -
get
get
- get
Process Instance(processInstanceKey): Promise<ProcessInstance> Parameters
- processInstanceKey: string | number
Returns Promise<ProcessInstance>
Description
Retrieve a specific process instance by id.
-Example
-const operate = new OperateApiClient()
const instance = await operate.getProcessInstance(2251799819847322) -
get
get
- get
Process Instance Statistics(processInstanceKey): Promise<ProcessInstanceStatistics[]> Parameters
- processInstanceKey: string | number
Returns Promise<ProcessInstanceStatistics[]>
Description
Get the statistics for a process instance, grouped by flow nodes
-
get
- get
Variables(variableKey): Promise<Operate.OperateDto.Variable> Parameters
- variableKey: string | number
Returns Promise<Operate.OperateDto.Variable>
Description
Return a variable identified by its variable key
-
get
- get
Variablesfor Process(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
-
Private safeJSONparse
search
- search
Decision Definitions(query): Promise<SearchResults<DecisionDefinition>> Parameters
- query: Query<DecisionDefinition>
Returns Promise<SearchResults<DecisionDefinition>>
search
- search
Decision Instances(query): Promise<SearchResults<DecisionInstance>> Parameters
- query: Query<DecisionInstance>
Returns Promise<SearchResults<DecisionInstance>>
search
- search
Decision Requirements(query): Promise<unknown> Parameters
- query: Query<DecisionRequirements>
Returns Promise<unknown>
search
- search
Flownode Instances(query): Promise<SearchResults<FlownodeInstance>> Parameters
- query: Query<FlownodeInstance>
Returns Promise<SearchResults<FlownodeInstance>>
search
- search
Incidents(query?): Promise<SearchResults<Incident>> Returns 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) -
search
- search
Process Definitions(query?): Promise<SearchResults<ProcessDefinition>> Parameters
- query: Query<ProcessDefinition> = {}
Returns Promise<SearchResults<ProcessDefinition>>
Description
Search and retrieve process definitions.
- -Example
-const query: Query<ProcessDefinition> = {
filter: {},
size: 50,
sort: [
{
field: "bpmnProcessId",
order: "ASC",
},
],
};
const operate = newOperateClient()
const defs = await operate.searchProcessDefinitions(query); -
search
- search
Process Instances(query?): Promise<SearchResults<ProcessInstance>> Parameters
- query: Query<ProcessInstance> = {}
Returns Promise<SearchResults<ProcessInstance>>
Description
Search and retrieve process instances.
-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`) -
search
- search
Variables(query): Promise<SearchResults<Operate.OperateDto.Variable>> Parameters
- query: Query<Operate.OperateDto.Variable>
Returns Promise<SearchResults<Operate.OperateDto.Variable>>
Generated using TypeDoc
Class ChangeStatus
Extend the LosslessDto class with your own Dto classes to enable lossless parsing of int64 values.
-Decorate fields with @Int64String or @BigIntValue to specify how int64 JSON numbers should be parsed.
Example
class MyDto extends LosslessDto {
@Int64String
int64NumberField: string
@BigIntValue
bigintField: bigint
@ChildDto(MyChildDto)
childDtoField: MyChildDto
normalField: string
normalNumberField: number
}
-Hierarchy (view full)
- LosslessDto
- ChangeStatus
Index
Constructors
Properties
Constructors
constructor
- new
Change Status(obj): ChangeStatus Parameters
- obj: any
Returns ChangeStatus
Properties
deleted
deleted: string
message
message: string
Generated using TypeDoc
Class DecisionDefinition
Extend the LosslessDto class with your own Dto classes to enable lossless parsing of int64 values.
-Decorate fields with @Int64String or @BigIntValue to specify how int64 JSON numbers should be parsed.
Example
class MyDto extends LosslessDto {
@Int64String
int64NumberField: string
@BigIntValue
bigintField: bigint
@ChildDto(MyChildDto)
childDtoField: MyChildDto
normalField: string
normalNumberField: number
}
-Hierarchy (view full)
- LosslessDto
- DecisionDefinition
Index
Constructors
Properties
Constructors
constructor
- new
Decision Definition(obj): DecisionDefinition Parameters
- obj: any
Returns DecisionDefinition
Properties
decision
decision
decision
decision
decision
decision
decision
decision
decision
decision
id
id: string
key
key: string
name
name: string
tenant
tenant
version
version: number
Generated using TypeDoc
Class DecisionInstance
Extend the LosslessDto class with your own Dto classes to enable lossless parsing of int64 values.
-Decorate fields with @Int64String or @BigIntValue to specify how int64 JSON numbers should be parsed.
Example
class MyDto extends LosslessDto {
@Int64String
int64NumberField: string
@BigIntValue
bigintField: bigint
@ChildDto(MyChildDto)
childDtoField: MyChildDto
normalField: string
normalNumberField: number
}
-Hierarchy (view full)
- LosslessDto
- DecisionInstance
Index
Constructors
Properties
Constructors
constructor
- new
Decision Instance(obj): DecisionInstance Parameters
- obj: any
Returns DecisionInstance
Properties
decision
decision
decision
decision
decision
decision
decision
decision
decision
decision
evaluated
evaluated
evaluation
evaluation
evaluation
evaluation
id
id: string
key
key: string
process
process
result
result: string
state
state: "FAILED" | "EVALUATED" | "UNKNOWN" | "UNSPECIFIED"
tenant
tenant
Generated using TypeDoc
Class DecisionInstanceInput
Extend the LosslessDto class with your own Dto classes to enable lossless parsing of int64 values.
-Decorate fields with @Int64String or @BigIntValue to specify how int64 JSON numbers should be parsed.
Example
class MyDto extends LosslessDto {
@Int64String
int64NumberField: string
@BigIntValue
bigintField: bigint
@ChildDto(MyChildDto)
childDtoField: MyChildDto
normalField: string
normalNumberField: number
}
-Hierarchy (view full)
- LosslessDto
- DecisionInstanceInput
Index
Constructors
Properties
Constructors
constructor
- new
Decision Instance Input(obj): DecisionInstanceInput Parameters
- obj: any
Returns DecisionInstanceInput
Properties
id
id: string
name
name: string
value
value: string
Generated using TypeDoc
Class DecisionInstanceOutput
Extend the LosslessDto class with your own Dto classes to enable lossless parsing of int64 values.
-Decorate fields with @Int64String or @BigIntValue to specify how int64 JSON numbers should be parsed.
Example
class MyDto extends LosslessDto {
@Int64String
int64NumberField: string
@BigIntValue
bigintField: bigint
@ChildDto(MyChildDto)
childDtoField: MyChildDto
normalField: string
normalNumberField: number
}
-Hierarchy (view full)
- LosslessDto
- DecisionInstanceOutput
Constructors
constructor
- new
Decision Instance Output(obj): DecisionInstanceOutput Parameters
- obj: any
Returns DecisionInstanceOutput
Properties
id
id: string
name
name: string
rule
rule
rule
rule
value
value: string
Generated using TypeDoc
Class DecisionRequirements
Extend the LosslessDto class with your own Dto classes to enable lossless parsing of int64 values.
-Decorate fields with @Int64String or @BigIntValue to specify how int64 JSON numbers should be parsed.
Example
class MyDto extends LosslessDto {
@Int64String
int64NumberField: string
@BigIntValue
bigintField: bigint
@ChildDto(MyChildDto)
childDtoField: MyChildDto
normalField: string
normalNumberField: number
}
-Hierarchy (view full)
- LosslessDto
- DecisionRequirements
Index
Constructors
Properties
Constructors
constructor
- new
Decision Requirements(obj): DecisionRequirements Parameters
- obj: any
Returns DecisionRequirements
Properties
decision
decision
id
id: string
key
key: string
name
name: string
resource
resource
tenant
tenant
version
version: number
Generated using TypeDoc
Class FlownodeInstance
Extend the LosslessDto class with your own Dto classes to enable lossless parsing of int64 values.
-Decorate fields with @Int64String or @BigIntValue to specify how int64 JSON numbers should be parsed.
Example
class MyDto extends LosslessDto {
@Int64String
int64NumberField: string
@BigIntValue
bigintField: bigint
@ChildDto(MyChildDto)
childDtoField: MyChildDto
normalField: string
normalNumberField: number
}
-Hierarchy (view full)
- LosslessDto
- FlownodeInstance
Index
Constructors
Properties
Constructors
constructor
- new
Flownode Instance(obj): FlownodeInstance Parameters
- obj: any
Returns FlownodeInstance
Properties
end
end
incident
incident: boolean
Optional incident
incident
key
key: string
process
process
start
start
state
state: "ACTIVE" | "COMPLETED" | "TERMINATED"
tenant
tenant
type
type: "UNKNOWN" | "UNSPECIFIED" | "PROCESS" | "SUB_PROCESS" | "EVENT_SUB_PROCESS" | "START_EVENT" | "INTERMEDIATE_CATCH_EVENT" | "INTERMEDIATE_THROW_EVENT" | "BOUNDARY_EVENT" | "END_EVENT" | "SERVICE_TASK" | "RECEIVE_TASK" | "USER_TASK" | "MANUAL_TASK" | "TASK" | "EXCLUSIVE_GATEWAY" | "INCLUSIVE_GATEWAY" | "PARALLEL_GATEWAY" | "EVENT_BASED_GATEWAY" | "SEQUENCE_FLOW" | "MULTI_INSTANCE_BODY" | "CALL_ACTIVITY" | "BUSINESS_RULE_TASK" | "SCRIPT_TASK" | "SEND_TASK"
Generated using TypeDoc
Class Incident
Extend the LosslessDto class with your own Dto classes to enable lossless parsing of int64 values.
-Decorate fields with @Int64String or @BigIntValue to specify how int64 JSON numbers should be parsed.
Example
class MyDto extends LosslessDto {
@Int64String
int64NumberField: string
@BigIntValue
bigintField: bigint
@ChildDto(MyChildDto)
childDtoField: MyChildDto
normalField: string
normalNumberField: number
}
-Hierarchy (view full)
- LosslessDto
- Incident
Index
Constructors
Properties
Constructors
constructor
Properties
creation
creation
job
job
key
key: string
message
message: string
process
process
process
process
state
state: "ACTIVE" | "RESOLVED"
tenant
tenant
type
type: "UNKNOWN" | "UNSPECIFIED" | "IO_MAPPING_ERROR" | "JOB_NO_RETRIES" | "CONDITION_ERROR" | "EXTRACT_VALUE_ERROR" | "CALLED_ELEMENT_ERROR" | "UNHANDLED_ERROR_EVENT" | "MESSAGE_SIZE_EXCEEDED" | "CALLED_DECISION_ERROR" | "DECISION_EVALUATION_ERROR"
Generated using TypeDoc
Class ProcessDefinition
Extend the LosslessDto class with your own Dto classes to enable lossless parsing of int64 values.
-Decorate fields with @Int64String or @BigIntValue to specify how int64 JSON numbers should be parsed.
Example
class MyDto extends LosslessDto {
@Int64String
int64NumberField: string
@BigIntValue
bigintField: bigint
@ChildDto(MyChildDto)
childDtoField: MyChildDto
normalField: string
normalNumberField: number
}
-Hierarchy (view full)
- LosslessDto
- ProcessDefinition
Index
Constructors
Properties
Constructors
constructor
- new
Process Definition(obj): ProcessDefinition Parameters
- obj: any
Returns ProcessDefinition
Properties
bpmn
bpmn
key
key: string
ProcessDefinition key is a string in the SDK, but it's an int64 number in the database
-name
name: string
version
version: number
Generated using TypeDoc
Class ProcessInstance
Extend the LosslessDto class with your own Dto classes to enable lossless parsing of int64 values.
-Decorate fields with @Int64String or @BigIntValue to specify how int64 JSON numbers should be parsed.
Example
class MyDto extends LosslessDto {
@Int64String
int64NumberField: string
@BigIntValue
bigintField: bigint
@ChildDto(MyChildDto)
childDtoField: MyChildDto
normalField: string
normalNumberField: number
}
-Hierarchy (view full)
- LosslessDto
- ProcessInstance
Index
Constructors
Properties
Constructors
constructor
- new
Process Instance(obj): ProcessInstance Parameters
- obj: any
Returns ProcessInstance
Properties
bpmn
bpmn
end
end
key
key: string
Optional parent
parent
Optional parent
parent
process
process
process
process
start
start
state
state: "ACTIVE" | "COMPLETED" | "CANCELED"
tenant
tenant
Generated using TypeDoc
Class ProcessInstanceStatistics
Extend the LosslessDto class with your own Dto classes to enable lossless parsing of int64 values.
-Decorate fields with @Int64String or @BigIntValue to specify how int64 JSON numbers should be parsed.
Example
class MyDto extends LosslessDto {
@Int64String
int64NumberField: string
@BigIntValue
bigintField: bigint
@ChildDto(MyChildDto)
childDtoField: MyChildDto
normalField: string
normalNumberField: number
}
-Hierarchy (view full)
- LosslessDto
- ProcessInstanceStatistics
Index
Constructors
Properties
Constructors
constructor
- new
Process Instance Statistics(obj): ProcessInstanceStatistics Parameters
- obj: any
Returns ProcessInstanceStatistics
Properties
active
active: string
activity
activity
canceled
canceled: string
completed
completed: string
incidents
incidents: string
Generated using TypeDoc
Class Variable
Extend the LosslessDto class with your own Dto classes to enable lossless parsing of int64 values.
-Decorate fields with @Int64String or @BigIntValue to specify how int64 JSON numbers should be parsed.
Example
class MyDto extends LosslessDto {
@Int64String
int64NumberField: string
@BigIntValue
bigintField: bigint
@ChildDto(MyChildDto)
childDtoField: MyChildDto
normalField: string
normalNumberField: number
}
-Hierarchy (view full)
- LosslessDto
- Variable
Index
Constructors
Properties
Constructors
constructor
- new
Variable(obj): Operate.OperateDto.Variable Parameters
- obj: any
Returns Operate.OperateDto.Variable
Properties
key
key: string
name
name: string
process
process
scope
scope
truncated
truncated: boolean
value
value: string
Generated using TypeDoc
Class OptimizeApiClient
Description
The high-level API client for Optimize.
-Example
const optimize = new OptimizeApiClient()
async function main() {
await optimize.enableSharing()
const id = "8a7103a7-c086-48f8-b5b7-a7f83e864688"
const res = await optimize.exportDashboardDefinitions([id])
fs.writeFileSync('exported-dashboard.json', JSON.stringify(res, null, 2))
}
main()
- Index
Constructors
Properties
Methods
Constructors
constructor
- new
Optimize Api Client(options?): OptimizeApiClient Parameters
Optionaloptions: {
config?: DeepPartial<{
CAMUNDA_CONSOLE_BASE_URL: undefined | string;
CAMUNDA_CONSOLE_CLIENT_ID: undefined | string;
CAMUNDA_CONSOLE_CLIENT_SECRET: undefined | string;
CAMUNDA_CONSOLE_OAUTH_AUDIENCE: string;
CAMUNDA_CUSTOM_CERT_CHAIN_PATH: undefined | string;
CAMUNDA_CUSTOM_PRIVATE_KEY_PATH: undefined | string;
CAMUNDA_CUSTOM_ROOT_CERT_PATH: undefined | string;
CAMUNDA_CUSTOM_USER_AGENT_STRING: undefined | string;
CAMUNDA_MODELER_BASE_URL: string;
CAMUNDA_MODELER_OAUTH_AUDIENCE: undefined | string;
CAMUNDA_OAUTH_DISABLED: boolean;
CAMUNDA_OAUTH_TOKEN_REFRESH_THRESHOLD_MS: number;
CAMUNDA_OAUTH_URL: undefined | string;
CAMUNDA_OPERATE_BASE_URL: undefined | string;
CAMUNDA_OPERATE_OAUTH_AUDIENCE: string;
CAMUNDA_OPTIMIZE_BASE_URL: undefined | string;
CAMUNDA_OPTIMIZE_OAUTH_AUDIENCE: string;
CAMUNDA_SECURE_CONNECTION: boolean;
CAMUNDA_TASKLIST_BASE_URL: undefined | string;
CAMUNDA_TASKLIST_OAUTH_AUDIENCE: string;
CAMUNDA_TENANT_ID: undefined | string;
CAMUNDA_TOKEN_CACHE_DIR: undefined | string;
CAMUNDA_TOKEN_DISK_CACHE_DISABLE: boolean;
CAMUNDA_TOKEN_SCOPE: undefined | string;
CAMUNDA_ZEEBE_OAUTH_AUDIENCE: string;
ZEEBE_ADDRESS: string;
ZEEBE_CLIENT_ID: undefined | string;
ZEEBE_CLIENT_SECRET: undefined | string;
zeebeGrpcSettings: {
GRPC_HTTP2_MAX_PINGS_WITHOUT_DATA: number;
GRPC_HTTP2_MIN_PING_INTERVAL_WITHOUT_DATA_MS: number;
GRPC_HTTP2_MIN_TIME_BETWEEN_PINGS_MS: number;
GRPC_INITIAL_RECONNECT_BACKOFF_MS: string | number;
GRPC_KEEPALIVE_PERMIT_WITHOUT_CALLS: number;
GRPC_KEEPALIVE_TIMEOUT_MS: number;
GRPC_KEEPALIVE_TIME_MS: number;
GRPC_MAX_RECONNECT_BACKOFF_MS: string | number;
GRPC_MIN_RECONNECT_BACKOFF_MS: string | number;
ZEEBE_CLIENT_LOG_LEVEL: string;
ZEEBE_CLIENT_LOG_TYPE: string;
ZEEBE_GRPC_CLIENT_CONNECTION_TOLERANCE_MS: number;
ZEEBE_GRPC_CLIENT_EAGER_CONNECT: boolean;
ZEEBE_GRPC_CLIENT_INITIAL_CONNECTION_TOLERANCE_MS: undefined | number;
ZEEBE_GRPC_CLIENT_MAX_RETRIES: number;
ZEEBE_GRPC_CLIENT_MAX_RETRY_TIMEOUT_SECONDS: number;
ZEEBE_GRPC_CLIENT_RETRY: boolean;
ZEEBE_GRPC_WORKER_LONGPOLL_SECONDS: number;
ZEEBE_GRPC_WORKER_POLL_INTERVAL_MS: number;
};
}>;
oAuthProvider?: IOAuthProvider;
}Optionalconfig?: DeepPartial<{
CAMUNDA_CONSOLE_BASE_URL: undefined | string;
CAMUNDA_CONSOLE_CLIENT_ID: undefined | string;
CAMUNDA_CONSOLE_CLIENT_SECRET: undefined | string;
CAMUNDA_CONSOLE_OAUTH_AUDIENCE: string;
CAMUNDA_CUSTOM_CERT_CHAIN_PATH: undefined | string;
CAMUNDA_CUSTOM_PRIVATE_KEY_PATH: undefined | string;
CAMUNDA_CUSTOM_ROOT_CERT_PATH: undefined | string;
CAMUNDA_CUSTOM_USER_AGENT_STRING: undefined | string;
CAMUNDA_MODELER_BASE_URL: string;
CAMUNDA_MODELER_OAUTH_AUDIENCE: undefined | string;
CAMUNDA_OAUTH_DISABLED: boolean;
CAMUNDA_OAUTH_TOKEN_REFRESH_THRESHOLD_MS: number;
CAMUNDA_OAUTH_URL: undefined | string;
CAMUNDA_OPERATE_BASE_URL: undefined | string;
CAMUNDA_OPERATE_OAUTH_AUDIENCE: string;
CAMUNDA_OPTIMIZE_BASE_URL: undefined | string;
CAMUNDA_OPTIMIZE_OAUTH_AUDIENCE: string;
CAMUNDA_SECURE_CONNECTION: boolean;
CAMUNDA_TASKLIST_BASE_URL: undefined | string;
CAMUNDA_TASKLIST_OAUTH_AUDIENCE: string;
CAMUNDA_TENANT_ID: undefined | string;
CAMUNDA_TOKEN_CACHE_DIR: undefined | string;
CAMUNDA_TOKEN_DISK_CACHE_DISABLE: boolean;
CAMUNDA_TOKEN_SCOPE: undefined | string;
CAMUNDA_ZEEBE_OAUTH_AUDIENCE: string;
ZEEBE_ADDRESS: string;
ZEEBE_CLIENT_ID: undefined | string;
ZEEBE_CLIENT_SECRET: undefined | string;
zeebeGrpcSettings: {
GRPC_HTTP2_MAX_PINGS_WITHOUT_DATA: number;
GRPC_HTTP2_MIN_PING_INTERVAL_WITHOUT_DATA_MS: number;
GRPC_HTTP2_MIN_TIME_BETWEEN_PINGS_MS: number;
GRPC_INITIAL_RECONNECT_BACKOFF_MS: string | number;
GRPC_KEEPALIVE_PERMIT_WITHOUT_CALLS: number;
GRPC_KEEPALIVE_TIMEOUT_MS: number;
GRPC_KEEPALIVE_TIME_MS: number;
GRPC_MAX_RECONNECT_BACKOFF_MS: string | number;
GRPC_MIN_RECONNECT_BACKOFF_MS: string | number;
ZEEBE_CLIENT_LOG_LEVEL: string;
ZEEBE_CLIENT_LOG_TYPE: string;
ZEEBE_GRPC_CLIENT_CONNECTION_TOLERANCE_MS: number;
ZEEBE_GRPC_CLIENT_EAGER_CONNECT: boolean;
ZEEBE_GRPC_CLIENT_INITIAL_CONNECTION_TOLERANCE_MS: undefined | number;
ZEEBE_GRPC_CLIENT_MAX_RETRIES: number;
ZEEBE_GRPC_CLIENT_MAX_RETRY_TIMEOUT_SECONDS: number;
ZEEBE_GRPC_CLIENT_RETRY: boolean;
ZEEBE_GRPC_WORKER_LONGPOLL_SECONDS: number;
ZEEBE_GRPC_WORKER_POLL_INTERVAL_MS: number;
};
}>OptionaloAuth Provider?: IOAuthProvider
Returns OptimizeApiClient
Example
-const optimize = new OptimizeApiClient() -
Properties
Private o
Private rest
rest: Got
Private user
user
Methods
delete
- delete
Report(reportId): Promise<string> Parameters
- reportId: string
The ID of the report you wish to delete
-
Returns Promise<string>
Description
The report deletion API allows you to delete reports by ID from Optimize.
- -Example
-const client = new OptimizeApiClient()
client.deleteReport("e6c5aaa1-6a18-44e7-8480-d562d511ba62") -- reportId: string
disable
- disable
Sharing(): Promise<Response<string>> Returns Promise<Response<string>>
Description
This API allows users to disable the sharing functionality for all reports and dashboards in Optimize.
-Note that this setting will be permanently persisted in memory and will take precedence over any other previous configurations (e.g. configuration files).
-When sharing is disabled, previously shared URLs will no longer be accessible. Upon re-enabling sharing, the previously shared URLs will work once again under the same address as before. Calling this endpoint when sharing is already disabled will have no effect.
- -Example
-const client = new OptimizeApiClient()
client.disableSharing() -
enable
- enable
Sharing(): Promise<Response<string>> Returns Promise<Response<string>>
Description
This API allows users to enable the sharing functionality for all reports and dashboards in Optimize.
-Note that this setting will be permanently persisted in memory and will take precedence over any other previous configurations (e.g. configuration files).
-If sharing had been previously enabled and then disabled, re-enabling sharing will allow users to access previously shared URLs under the same address as before. Calling this endpoint when sharing is already enabled will have no effect.
- -Example
-const client = new OptimizeApiClient()
client.enableSharing() -
export
- export
Dashboard Definitions(dashboardIds): Promise<unknown[]> Parameters
- dashboardIds: string[]
Array of dashboard ids
-
Returns Promise<unknown[]>
Description
This API allows users to export dashboard definitions which can later be imported into another Optimize system.
-Note that exporting a dashboard also exports all reports contained within the dashboard. The dashboards to be exported may be within a Collection or private entities, the API has access to both.
-The obtained list of entity exports can be imported into other Optimize systems either using the dedicated import API or via UI.
- -Example
-const client = new OptimizeApiClient()
const dashboardDefs = await client.exportDashboardDefinitions(["123", "456"]) -- dashboardIds: string[]
export
- export
Report Definitions(reportIds): Promise<unknown[]> Parameters
- reportIds: string[]
array of report IDs
-
Returns Promise<unknown[]>
Description
This API allows users to export report definitions which can later be imported into another Optimize system. The reports to be exported may be within a collection or private entities, the API has access to both.
-The obtained list of entity exports can be imported into other Optimize systems either using the dedicated import API or via UI.
- -Example
-const client = new OptimizeApiClient()
const reportDefs = await client.exportReportDefinitions(["123", "456"]) -- reportIds: string[]
export
- export
Report Result Data(reportId, limit?, paginationTimeoutSec?): ReportDataExporter Parameters
- reportId: string
- limit: number = 2
- paginationTimeoutSec: number = 60
Returns ReportDataExporter
Description
The data export API allows users to export large amounts of data in a machine-readable format (JSON) from Optimize.
-Example
-const client = new OptimizeApiClient()
const exporter = client.exportReportResultData("e6c5aaa1-6a18-44e7-8480-d562d511ba62")
const page1 = await exporter.next() -
get
- get
Dashboard Ids(collectionId): Promise<DashboardCollection> Parameters
- collectionId: number
The ID of the collection for which to retrieve the dashboard IDs.
-
Returns Promise<DashboardCollection>
Description
This API allows users to retrieve all dashboard IDs from a given collection.
-The response contains a list of IDs of the dashboards existing in the collection with the given collection ID.
- -Example
-const client = new OptimizeApiClient()
const dashboardIds = await client.getDashboardIds(1234) -- collectionId: number
Private get
- get
Headers(auth?): Promise<{
accept: string;
authorization: string;
content-type: string;
user-agent: string;
} | {
accept: string;
content-type: string;
user-agent: string;
}> Parameters
- auth: boolean = true
Returns Promise<{
accept: string;
authorization: string;
content-type: string;
user-agent: string;
} | {
accept: string;
content-type: string;
user-agent: string;
}>
get
- get
Readiness(): Promise<unknown> Returns Promise<unknown>
Description
The purpose of Health-Readiness REST API is to return information indicating whether Optimize is ready to be used.
- -Example
-const client = new OptimizeApiClient()
try {
await client.getReadiness()
console.log('Ready!')
} catch (e: any) {
console.log('Error calling readiness point: ' + e.code)
} -
get
- get
Report Ids(collectionId): Promise<ReportCollection> Parameters
- collectionId: number
the id of the collection
-
Returns Promise<ReportCollection>
Description
This API allows users to retrieve all report IDs from a given collection. The response contains a list of IDs of the reports existing in the collection with the given collection ID.
- -Example
-const client = new OptimizeApiClient()
const reports = await client.getReportIds(1234) -- collectionId: number
import
- import
Entities(collectionId, entities): Promise<EntityImportResponse> Parameters
- collectionId: number
- entities: unknown
Returns Promise<EntityImportResponse>
Description
This API allows users to import entity definitions such as reports and dashboards into existing collections. These entity definitions may be obtained either using the report or dashboard export API or via the UI.
- -Example
-const entities = [
{
"id": "61ae2232-51e1-4c35-b72c-c7152ba264f9",
"exportEntityType": "single_process_report",
"name": "Number: Process instance duration",
"sourceIndexVersion": 8,
"collectionId": null,
"data": {...}
},
{
"id": "b0eb845-e8ed-4824-bd85-8cd69038f2f5",
"exportEntityType": "dashboard",
"name": "Dashboard 1",
"sourceIndexVersion": 5,
"reports": [
{
"id": "61ae2232-51e1-4c35-b72c-c7152ba264f9",
...
}
],
"availableFilters": [...],
"collectionId": null
}
]
const client = new OptimizeApiClient()
await client.importEntities(123, entities) -
ingest
- ingest
External Variable(variables): Promise<unknown> Parameters
- variables: Optimize.OptimizeDto.Variable[]
Returns Promise<unknown>
Description
With the external variable ingestion API, variable data held in external systems can be ingested into Optimize directly, without the need for these variables to be present in your Camunda platform data. This can be useful when external business data, which is relevant for process analysis in Optimize, is to be associated with specific process instances.
-Especially if this data changes over time, it is advisable to use this REST API to persist external variable updates to Optimize, as otherwise Optimize may not be aware of data changes in the external system.
-Example
-const variables = [
{
"id": "7689fced-2639-4408-9de1-cf8f72769f43",
"name": "address",
"type": "string",
"value": "Main Street 1",
"processInstanceId": "c6393461-02bb-4f62-a4b7-f2f8d9bbbac1",
"processDefinitionKey": "shippingProcess"
},
{
"id": "993f4e73-7f6a-46a6-bd45-f4f8e3470ba1",
"name": "amount",
"type": "integer",
"value": "500",
"processInstanceId": "8282ed49-2243-44df-be5e-1bf893755d8f",
"processDefinitionKey": "orderProcess"
}
]
const client = new OptimizeApiClient()
client.ingestExternalVariable(variables) -
label
- label
Variables(variableLabels): Promise<unknown> Parameters
- variableLabels: VariableLabels
Returns Promise<unknown>
Description
With the variable labeling endpoint, variable labels can be added, updated, and deleted from Optimize.
- -Example
-const variableLabels = {
"definitionKey": "bookrequest-1-tenant",
"labels" : [
{
"variableName": "bookAvailable",
"variableType": "Boolean",
"variableLabel": "book availability"
},
{
"variableName": "person.name",
"variableType": "String",
"variableLabel": "first and last name"
},
{
"variableName": "person.hobbies._listSize",
"variableType": "Long",
"variableLabel": "amount of hobbies"
}
]
}
const client = new OptimizeApiClient()
await client.labelVariables(variableLabels) -
Generated using TypeDoc
Class TasklistApiClient
Description
The high-level client for the Tasklist REST API
-Example
- Index
Constructors
Properties
Methods
Constructors
constructor
- new
Tasklist Api Client(options?): TasklistApiClient Parameters
Optionaloptions: {
config?: DeepPartial<{
CAMUNDA_CONSOLE_BASE_URL: undefined | string;
CAMUNDA_CONSOLE_CLIENT_ID: undefined | string;
CAMUNDA_CONSOLE_CLIENT_SECRET: undefined | string;
CAMUNDA_CONSOLE_OAUTH_AUDIENCE: string;
CAMUNDA_CUSTOM_CERT_CHAIN_PATH: undefined | string;
CAMUNDA_CUSTOM_PRIVATE_KEY_PATH: undefined | string;
CAMUNDA_CUSTOM_ROOT_CERT_PATH: undefined | string;
CAMUNDA_CUSTOM_USER_AGENT_STRING: undefined | string;
CAMUNDA_MODELER_BASE_URL: string;
CAMUNDA_MODELER_OAUTH_AUDIENCE: undefined | string;
CAMUNDA_OAUTH_DISABLED: boolean;
CAMUNDA_OAUTH_TOKEN_REFRESH_THRESHOLD_MS: number;
CAMUNDA_OAUTH_URL: undefined | string;
CAMUNDA_OPERATE_BASE_URL: undefined | string;
CAMUNDA_OPERATE_OAUTH_AUDIENCE: string;
CAMUNDA_OPTIMIZE_BASE_URL: undefined | string;
CAMUNDA_OPTIMIZE_OAUTH_AUDIENCE: string;
CAMUNDA_SECURE_CONNECTION: boolean;
CAMUNDA_TASKLIST_BASE_URL: undefined | string;
CAMUNDA_TASKLIST_OAUTH_AUDIENCE: string;
CAMUNDA_TENANT_ID: undefined | string;
CAMUNDA_TOKEN_CACHE_DIR: undefined | string;
CAMUNDA_TOKEN_DISK_CACHE_DISABLE: boolean;
CAMUNDA_TOKEN_SCOPE: undefined | string;
CAMUNDA_ZEEBE_OAUTH_AUDIENCE: string;
ZEEBE_ADDRESS: string;
ZEEBE_CLIENT_ID: undefined | string;
ZEEBE_CLIENT_SECRET: undefined | string;
zeebeGrpcSettings: {
GRPC_HTTP2_MAX_PINGS_WITHOUT_DATA: number;
GRPC_HTTP2_MIN_PING_INTERVAL_WITHOUT_DATA_MS: number;
GRPC_HTTP2_MIN_TIME_BETWEEN_PINGS_MS: number;
GRPC_INITIAL_RECONNECT_BACKOFF_MS: string | number;
GRPC_KEEPALIVE_PERMIT_WITHOUT_CALLS: number;
GRPC_KEEPALIVE_TIMEOUT_MS: number;
GRPC_KEEPALIVE_TIME_MS: number;
GRPC_MAX_RECONNECT_BACKOFF_MS: string | number;
GRPC_MIN_RECONNECT_BACKOFF_MS: string | number;
ZEEBE_CLIENT_LOG_LEVEL: string;
ZEEBE_CLIENT_LOG_TYPE: string;
ZEEBE_GRPC_CLIENT_CONNECTION_TOLERANCE_MS: number;
ZEEBE_GRPC_CLIENT_EAGER_CONNECT: boolean;
ZEEBE_GRPC_CLIENT_INITIAL_CONNECTION_TOLERANCE_MS: undefined | number;
ZEEBE_GRPC_CLIENT_MAX_RETRIES: number;
ZEEBE_GRPC_CLIENT_MAX_RETRY_TIMEOUT_SECONDS: number;
ZEEBE_GRPC_CLIENT_RETRY: boolean;
ZEEBE_GRPC_WORKER_LONGPOLL_SECONDS: number;
ZEEBE_GRPC_WORKER_POLL_INTERVAL_MS: number;
};
}>;
oAuthProvider?: IOAuthProvider;
}Optionalconfig?: DeepPartial<{
CAMUNDA_CONSOLE_BASE_URL: undefined | string;
CAMUNDA_CONSOLE_CLIENT_ID: undefined | string;
CAMUNDA_CONSOLE_CLIENT_SECRET: undefined | string;
CAMUNDA_CONSOLE_OAUTH_AUDIENCE: string;
CAMUNDA_CUSTOM_CERT_CHAIN_PATH: undefined | string;
CAMUNDA_CUSTOM_PRIVATE_KEY_PATH: undefined | string;
CAMUNDA_CUSTOM_ROOT_CERT_PATH: undefined | string;
CAMUNDA_CUSTOM_USER_AGENT_STRING: undefined | string;
CAMUNDA_MODELER_BASE_URL: string;
CAMUNDA_MODELER_OAUTH_AUDIENCE: undefined | string;
CAMUNDA_OAUTH_DISABLED: boolean;
CAMUNDA_OAUTH_TOKEN_REFRESH_THRESHOLD_MS: number;
CAMUNDA_OAUTH_URL: undefined | string;
CAMUNDA_OPERATE_BASE_URL: undefined | string;
CAMUNDA_OPERATE_OAUTH_AUDIENCE: string;
CAMUNDA_OPTIMIZE_BASE_URL: undefined | string;
CAMUNDA_OPTIMIZE_OAUTH_AUDIENCE: string;
CAMUNDA_SECURE_CONNECTION: boolean;
CAMUNDA_TASKLIST_BASE_URL: undefined | string;
CAMUNDA_TASKLIST_OAUTH_AUDIENCE: string;
CAMUNDA_TENANT_ID: undefined | string;
CAMUNDA_TOKEN_CACHE_DIR: undefined | string;
CAMUNDA_TOKEN_DISK_CACHE_DISABLE: boolean;
CAMUNDA_TOKEN_SCOPE: undefined | string;
CAMUNDA_ZEEBE_OAUTH_AUDIENCE: string;
ZEEBE_ADDRESS: string;
ZEEBE_CLIENT_ID: undefined | string;
ZEEBE_CLIENT_SECRET: undefined | string;
zeebeGrpcSettings: {
GRPC_HTTP2_MAX_PINGS_WITHOUT_DATA: number;
GRPC_HTTP2_MIN_PING_INTERVAL_WITHOUT_DATA_MS: number;
GRPC_HTTP2_MIN_TIME_BETWEEN_PINGS_MS: number;
GRPC_INITIAL_RECONNECT_BACKOFF_MS: string | number;
GRPC_KEEPALIVE_PERMIT_WITHOUT_CALLS: number;
GRPC_KEEPALIVE_TIMEOUT_MS: number;
GRPC_KEEPALIVE_TIME_MS: number;
GRPC_MAX_RECONNECT_BACKOFF_MS: string | number;
GRPC_MIN_RECONNECT_BACKOFF_MS: string | number;
ZEEBE_CLIENT_LOG_LEVEL: string;
ZEEBE_CLIENT_LOG_TYPE: string;
ZEEBE_GRPC_CLIENT_CONNECTION_TOLERANCE_MS: number;
ZEEBE_GRPC_CLIENT_EAGER_CONNECT: boolean;
ZEEBE_GRPC_CLIENT_INITIAL_CONNECTION_TOLERANCE_MS: undefined | number;
ZEEBE_GRPC_CLIENT_MAX_RETRIES: number;
ZEEBE_GRPC_CLIENT_MAX_RETRY_TIMEOUT_SECONDS: number;
ZEEBE_GRPC_CLIENT_RETRY: boolean;
ZEEBE_GRPC_WORKER_LONGPOLL_SECONDS: number;
ZEEBE_GRPC_WORKER_POLL_INTERVAL_MS: number;
};
}>OptionaloAuth Provider?: IOAuthProvider
Returns TasklistApiClient
Example
-const tasklist = new TasklistApiClient()
const tasks = await tasklist.getTasks({ state: TaskState.CREATED }) -Description
Properties
Private o
Private rest
rest: Got
Private user
user
Methods
assign
- assign
Task(__namedParameters): Promise<TaskResponse> Parameters
- __namedParameters: {
allowOverrideAssignment?: boolean;
assignee?: string;
taskId: string;
}OptionalallowOverride Assignment?: boolean Optionalassignee?: stringtask
Id: string
Returns Promise<TaskResponse>
Description
Assign a task with taskId to assignee or the active user.
-Throws
Status 400 - An error is returned when the task is not active (not in the CREATED state). -Status 400 - An error is returned when task was already assigned, except the case when JWT authentication token used and allowOverrideAssignment = true. -Status 403 - An error is returned when user doesn't have the permission to assign another user to this task. -Status 404 - An error is returned when the task with the taskId is not found.
-- __namedParameters: {
complete
- complete
Task(taskId, variables?): Promise<TaskResponse> Parameters
- taskId: string
Optionalvariables: JSONDoc
Returns Promise<TaskResponse>
Description
Complete a task with taskId and optional variables
-Throws
Status 400 An error is returned when the task is not active (not in the CREATED state).
-Throws
Status 400 An error is returned if the task was not claimed (assigned) before.
-Throws
Status 400 An error is returned if the task is not assigned to the current user.
-Throws
Status 403 User has no permission to access the task (Self-managed only).
-Throws
Status 404 An error is returned when the task with the taskId is not found.
-
get
Private get
get
- get
Task(taskId): Promise<TaskResponse> Parameters
- taskId: string
Returns Promise<TaskResponse>
Description
Return a task by id, or throw if not found.
-Throws
Will throw if no task of the given taskId exists
-
get
- get
Variable(variableId): Promise<Tasklist.TasklistDto.Variable> Parameters
- variableId: string
Returns Promise<Tasklist.TasklistDto.Variable>
Description
https://docs.camunda.io/docs/apis-clients/tasklist-api/queries/variable/
-Throws
Throws 404 if no variable of the id is found
-
get
- get
Variables(__namedParameters): Promise<VariableSearchResponse[]> Parameters
- __namedParameters: {
includeVariables?: {
alwaysReturnFullValue: boolean;
name: string;
}[];
taskId: string;
variableNames?: string[];
}OptionalincludeVariables?: {
alwaysReturnFullValue: boolean;
name: string;
}[]task
Id: string OptionalvariableNames?: string[]
Returns Promise<VariableSearchResponse[]>
Description
This method returns a list of task variables for the specified taskId and variableNames. If the variableNames parameter is empty, all variables associated with the task will be returned.
-Throws
Status 404 - An error is returned when the task with the taskId is not found.
-- __namedParameters: {
Private replace
- replace
Dates With String<T>(query): T Type Parameters
- T extends {
dueDate?: DateFilter;
followUpDate?: DateFilter;
}
Parameters
- query: T
Returns T
- T extends {
search
- search
Tasks(query): Promise<TaskSearchResponse[]> Parameters
Returns Promise<TaskSearchResponse[]>
Description
Query Tasklist for a list of tasks. See the API documentation.
-Throws
Status 400 - An error is returned when more than one search parameters among [
-searchAfter,searchAfterOrEqual,searchBefore,searchBeforeOrEqual] are present in requestExample
-const tasklist = new TasklistApiClient()
async function getTasks() {
const res = await tasklist.searchTasks({
state: TaskState.CREATED
})
console.log(res ? 'Nothing' : JSON.stringify(res, null, 2))
return res
} -
unassign
- unassign
Task(taskId): Promise<TaskResponse> Parameters
- taskId: string
Returns Promise<TaskResponse>
Description
Unassign a task with taskId
-Throws
Status 400 An error is returned when the task is not active (not in the CREATED state).
-Throws
Status 400 An error is returned if the task was not claimed (assigned) before.
-Throws
Status 404 An error is returned when the task with the taskId is not found.
-
Generated using TypeDoc
Class Form
Extend the LosslessDto class with your own Dto classes to enable lossless parsing of int64 values.
-Decorate fields with @Int64String or @BigIntValue to specify how int64 JSON numbers should be parsed.
Example
class MyDto extends LosslessDto {
@Int64String
int64NumberField: string
@BigIntValue
bigintField: bigint
@ChildDto(MyChildDto)
childDtoField: MyChildDto
normalField: string
normalNumberField: number
}
-Hierarchy (view full)
- LosslessDto
- Form
Index
Constructors
Properties
Constructors
constructor
Properties
id
id: string
is
is
process
process
schema
schema: string
tenant
tenant
version
version: string
Generated using TypeDoc
Class TaskResponse
Extend the LosslessDto class with your own Dto classes to enable lossless parsing of int64 values.
-Decorate fields with @Int64String or @BigIntValue to specify how int64 JSON numbers should be parsed.
Example
class MyDto extends LosslessDto {
@Int64String
int64NumberField: string
@BigIntValue
bigintField: bigint
@ChildDto(MyChildDto)
childDtoField: MyChildDto
normalField: string
normalNumberField: number
}
-Hierarchy (view full)
- LosslessDto
- TaskResponse
Index
Constructors
Properties
Constructors
constructor
- new
Task Response(obj): TaskResponse Parameters
- obj: any
Returns TaskResponse
Properties
assignee
assignee: string
candidate
candidate
candidate
candidate
completion
completion
creation
creation
due
due
follow
follow
form
form
form
form
Optional form
form
id
id: string
implementation
implementation: "JOB_WORKER" | "ZEEBE_USER_TASK"
Optional is
is
name
name: string
process
process
process
process
process
process
task
task
task
task
tenant
tenant
Generated using TypeDoc
Class TaskSearchResponse
Extend the LosslessDto class with your own Dto classes to enable lossless parsing of int64 values.
-Decorate fields with @Int64String or @BigIntValue to specify how int64 JSON numbers should be parsed.
Example
class MyDto extends LosslessDto {
@Int64String
int64NumberField: string
@BigIntValue
bigintField: bigint
@ChildDto(MyChildDto)
childDtoField: MyChildDto
normalField: string
normalNumberField: number
}
-Hierarchy (view full)
- TaskResponse
- TaskSearchResponse
Index
Constructors
Properties
Constructors
constructor
- new
Task Search Response(obj): TaskSearchResponse Parameters
- obj: any
Returns TaskSearchResponse
Properties
assignee
assignee: string
candidate
candidate
candidate
candidate
completion
completion
creation
creation
due
due
follow
follow
form
form
form
form
Optional form
form
id
id: string
implementation
implementation: "JOB_WORKER" | "ZEEBE_USER_TASK"
is
is
Optional is
is
name
name: string
process
process
process
process
process
process
sort
sort
task
task
task
task
tenant
tenant
variables
Generated using TypeDoc
Class BpmnParser
Index
Constructors
Properties
Methods
Constructors
constructor
- new
Bpmn Parser(): BpmnParser Returns BpmnParser
Properties
Static Private parser
parser: XMLParser = ...
Static Private parser
parser
allowBooleanAttributes: boolean;
attrNodeName: string;
attributeNamePrefix: string;
cdataPositionChar: string;
cdataTagName: string;
ignoreAttributes: boolean;
ignoreNameSpace: boolean;
localeRange: string;
parseAttributeValue: boolean;
parseNodeValue: boolean;
parseTrueNumberOnly: boolean;
textNodeName: string;
trimValues: boolean;
} = ...
allowBooleanAttributes: boolean;
attrNodeName: string;
attributeNamePrefix: string;
cdataPositionChar: string;
cdataTagName: string;
ignoreAttributes: boolean;
ignoreNameSpace: boolean;
localeRange: string;
parseAttributeValue: boolean;
parseNodeValue: boolean;
parseTrueNumberOnly: boolean;
textNodeName: string;
trimValues: boolean;
} = ...
Type declaration
allow
Boolean Attributes: boolean attr
Node Name: string attribute
Name Prefix: string cdata
Position Char: string cdata
Tag Name: string ignore
Attributes: boolean ignore
Name Space: boolean locale
Range: string parse
Attribute Value: boolean parse
Node Value: boolean parse
True Number Only: boolean text
Node Name: string trim
Values: boolean
Static task
task
Methods
Static generate
Static get
Static get
Static get
Static Private merge
Static parse
Static scaffold
Static Private scan
Static Private scan
Generated using TypeDoc
Class ZBWorker<WorkerInputVariables, CustomHeaderShape, WorkerOutputVariables>
Type Parameters
Hierarchy (view full)
Index
Constructors
Properties
Methods
close
-debug
-drain
Constructors
constructor
- new ZBWorker<WorkerInputVariables, CustomHeaderShape, WorkerOutputVariables>(config): ZBWorker<WorkerInputVariables, CustomHeaderShape, WorkerOutputVariables>
Type Parameters
Parameters
Returns ZBWorker<WorkerInputVariables, CustomHeaderShape, WorkerOutputVariables>
Properties
active
active
Protected cancel
cancel
grpc
Protected logger
max
max
poll
poll
Protected task
task
task
timeout
timeout: MaybeTimeDuration
Protected zb
Methods
close
debug
- debug(msg): void
Parameters
- msg: JSON
Returns void
Protected drain
emit
error
- error(msg): void
Parameters
- msg: JSON
Returns void
Protected handle
Protected handle
- handle
Jobs(jobs): void Parameters
- jobs: Job<WorkerInputVariables, CustomHeaderShape>[]
Returns void
log
- log(msg): void
Parameters
- msg: JSON
Returns void
Protected make
- make
Complete Handlers<T>(thisJob): JobCompletionInterface<T> Type Parameters
Parameters
- thisJob: Job<WorkerInputVariables, CustomHeaderShape>
Returns JobCompletionInterface<T>
off
- off<K>(eventName, fn): void
Type Parameters
- K extends EventKey<{
close: "close";
connectionError: "connectionError";
ready: "ready";
unknown: "unknown";
}>
Parameters
- eventName: K
- fn: EventReceiver
Returns void
- K extends EventKey<{
on
- on<K>(eventName, fn): ZBWorker<WorkerInputVariables, CustomHeaderShape, WorkerOutputVariables>
Type Parameters
- K extends EventKey<{
close: "close";
connectionError: "connectionError";
ready: "ready";
unknown: "unknown";
}>
Parameters
- eventName: K
- fn: EventReceiver
Returns ZBWorker<WorkerInputVariables, CustomHeaderShape, WorkerOutputVariables>
- K extends EventKey<{
remove
Generated using TypeDoc
Class ZeebeGrpcClient
Description
A client for interacting with a Zeebe broker. With the connection credentials set in the environment, you can use a "zero-conf" constructor with no arguments.
-Example
const zbc = new ZeebeGrpcClient()
zbc.topology().then(info =>
console.log(JSON.stringify(info, null, 2))
)
-Hierarchy (view full)
- TypedEmitter<typeof ConnectionStatusEvent>
- ZeebeGrpcClient
Index
Constructors
Properties
Methods
_on
Constructors
constructor
- new
Zeebe Grpc Client(options?): ZeebeGrpcClient Parameters
Optionaloptions: {
config?: DeepPartial<{
CAMUNDA_CONSOLE_BASE_URL: undefined | string;
CAMUNDA_CONSOLE_CLIENT_ID: undefined | string;
CAMUNDA_CONSOLE_CLIENT_SECRET: undefined | string;
CAMUNDA_CONSOLE_OAUTH_AUDIENCE: string;
CAMUNDA_CUSTOM_CERT_CHAIN_PATH: undefined | string;
CAMUNDA_CUSTOM_PRIVATE_KEY_PATH: undefined | string;
CAMUNDA_CUSTOM_ROOT_CERT_PATH: undefined | string;
CAMUNDA_CUSTOM_USER_AGENT_STRING: undefined | string;
CAMUNDA_MODELER_BASE_URL: string;
CAMUNDA_MODELER_OAUTH_AUDIENCE: undefined | string;
CAMUNDA_OAUTH_DISABLED: boolean;
CAMUNDA_OAUTH_TOKEN_REFRESH_THRESHOLD_MS: number;
CAMUNDA_OAUTH_URL: undefined | string;
CAMUNDA_OPERATE_BASE_URL: undefined | string;
CAMUNDA_OPERATE_OAUTH_AUDIENCE: string;
CAMUNDA_OPTIMIZE_BASE_URL: undefined | string;
CAMUNDA_OPTIMIZE_OAUTH_AUDIENCE: string;
CAMUNDA_SECURE_CONNECTION: boolean;
CAMUNDA_TASKLIST_BASE_URL: undefined | string;
CAMUNDA_TASKLIST_OAUTH_AUDIENCE: string;
CAMUNDA_TENANT_ID: undefined | string;
CAMUNDA_TOKEN_CACHE_DIR: undefined | string;
CAMUNDA_TOKEN_DISK_CACHE_DISABLE: boolean;
CAMUNDA_TOKEN_SCOPE: undefined | string;
CAMUNDA_ZEEBE_OAUTH_AUDIENCE: string;
ZEEBE_ADDRESS: string;
ZEEBE_CLIENT_ID: undefined | string;
ZEEBE_CLIENT_SECRET: undefined | string;
zeebeGrpcSettings: {
GRPC_HTTP2_MAX_PINGS_WITHOUT_DATA: number;
GRPC_HTTP2_MIN_PING_INTERVAL_WITHOUT_DATA_MS: number;
GRPC_HTTP2_MIN_TIME_BETWEEN_PINGS_MS: number;
GRPC_INITIAL_RECONNECT_BACKOFF_MS: string | number;
GRPC_KEEPALIVE_PERMIT_WITHOUT_CALLS: number;
GRPC_KEEPALIVE_TIMEOUT_MS: number;
GRPC_KEEPALIVE_TIME_MS: number;
GRPC_MAX_RECONNECT_BACKOFF_MS: string | number;
GRPC_MIN_RECONNECT_BACKOFF_MS: string | number;
ZEEBE_CLIENT_LOG_LEVEL: string;
ZEEBE_CLIENT_LOG_TYPE: string;
ZEEBE_GRPC_CLIENT_CONNECTION_TOLERANCE_MS: number;
ZEEBE_GRPC_CLIENT_EAGER_CONNECT: boolean;
ZEEBE_GRPC_CLIENT_INITIAL_CONNECTION_TOLERANCE_MS: undefined | number;
ZEEBE_GRPC_CLIENT_MAX_RETRIES: number;
ZEEBE_GRPC_CLIENT_MAX_RETRY_TIMEOUT_SECONDS: number;
ZEEBE_GRPC_CLIENT_RETRY: boolean;
ZEEBE_GRPC_WORKER_LONGPOLL_SECONDS: number;
ZEEBE_GRPC_WORKER_POLL_INTERVAL_MS: number;
};
}>;
oAuthProvider?: IOAuthProvider;
}Optionalconfig?: DeepPartial<{
CAMUNDA_CONSOLE_BASE_URL: undefined | string;
CAMUNDA_CONSOLE_CLIENT_ID: undefined | string;
CAMUNDA_CONSOLE_CLIENT_SECRET: undefined | string;
CAMUNDA_CONSOLE_OAUTH_AUDIENCE: string;
CAMUNDA_CUSTOM_CERT_CHAIN_PATH: undefined | string;
CAMUNDA_CUSTOM_PRIVATE_KEY_PATH: undefined | string;
CAMUNDA_CUSTOM_ROOT_CERT_PATH: undefined | string;
CAMUNDA_CUSTOM_USER_AGENT_STRING: undefined | string;
CAMUNDA_MODELER_BASE_URL: string;
CAMUNDA_MODELER_OAUTH_AUDIENCE: undefined | string;
CAMUNDA_OAUTH_DISABLED: boolean;
CAMUNDA_OAUTH_TOKEN_REFRESH_THRESHOLD_MS: number;
CAMUNDA_OAUTH_URL: undefined | string;
CAMUNDA_OPERATE_BASE_URL: undefined | string;
CAMUNDA_OPERATE_OAUTH_AUDIENCE: string;
CAMUNDA_OPTIMIZE_BASE_URL: undefined | string;
CAMUNDA_OPTIMIZE_OAUTH_AUDIENCE: string;
CAMUNDA_SECURE_CONNECTION: boolean;
CAMUNDA_TASKLIST_BASE_URL: undefined | string;
CAMUNDA_TASKLIST_OAUTH_AUDIENCE: string;
CAMUNDA_TENANT_ID: undefined | string;
CAMUNDA_TOKEN_CACHE_DIR: undefined | string;
CAMUNDA_TOKEN_DISK_CACHE_DISABLE: boolean;
CAMUNDA_TOKEN_SCOPE: undefined | string;
CAMUNDA_ZEEBE_OAUTH_AUDIENCE: string;
ZEEBE_ADDRESS: string;
ZEEBE_CLIENT_ID: undefined | string;
ZEEBE_CLIENT_SECRET: undefined | string;
zeebeGrpcSettings: {
GRPC_HTTP2_MAX_PINGS_WITHOUT_DATA: number;
GRPC_HTTP2_MIN_PING_INTERVAL_WITHOUT_DATA_MS: number;
GRPC_HTTP2_MIN_TIME_BETWEEN_PINGS_MS: number;
GRPC_INITIAL_RECONNECT_BACKOFF_MS: string | number;
GRPC_KEEPALIVE_PERMIT_WITHOUT_CALLS: number;
GRPC_KEEPALIVE_TIMEOUT_MS: number;
GRPC_KEEPALIVE_TIME_MS: number;
GRPC_MAX_RECONNECT_BACKOFF_MS: string | number;
GRPC_MIN_RECONNECT_BACKOFF_MS: string | number;
ZEEBE_CLIENT_LOG_LEVEL: string;
ZEEBE_CLIENT_LOG_TYPE: string;
ZEEBE_GRPC_CLIENT_CONNECTION_TOLERANCE_MS: number;
ZEEBE_GRPC_CLIENT_EAGER_CONNECT: boolean;
ZEEBE_GRPC_CLIENT_INITIAL_CONNECTION_TOLERANCE_MS: undefined | number;
ZEEBE_GRPC_CLIENT_MAX_RETRIES: number;
ZEEBE_GRPC_CLIENT_MAX_RETRY_TIMEOUT_SECONDS: number;
ZEEBE_GRPC_CLIENT_RETRY: boolean;
ZEEBE_GRPC_WORKER_LONGPOLL_SECONDS: number;
ZEEBE_GRPC_WORKER_POLL_INTERVAL_MS: number;
};
}>OptionaloAuth Provider?: IOAuthProvider
Returns ZeebeGrpcClient
Properties
Private Optional close
close
Private closing
closing: boolean = false
Private config
config: {
CAMUNDA_CONSOLE_BASE_URL: undefined | string;
CAMUNDA_CONSOLE_CLIENT_ID: undefined | string;
CAMUNDA_CONSOLE_CLIENT_SECRET: undefined | string;
CAMUNDA_CONSOLE_OAUTH_AUDIENCE: string;
CAMUNDA_CUSTOM_CERT_CHAIN_PATH: undefined | string;
CAMUNDA_CUSTOM_PRIVATE_KEY_PATH: undefined | string;
CAMUNDA_CUSTOM_ROOT_CERT_PATH: undefined | string;
CAMUNDA_CUSTOM_USER_AGENT_STRING: undefined | string;
CAMUNDA_MODELER_BASE_URL: string;
CAMUNDA_MODELER_OAUTH_AUDIENCE: undefined | string;
CAMUNDA_OAUTH_DISABLED: boolean;
CAMUNDA_OAUTH_TOKEN_REFRESH_THRESHOLD_MS: number;
CAMUNDA_OAUTH_URL: undefined | string;
CAMUNDA_OPERATE_BASE_URL: undefined | string;
CAMUNDA_OPERATE_OAUTH_AUDIENCE: string;
CAMUNDA_OPTIMIZE_BASE_URL: undefined | string;
CAMUNDA_OPTIMIZE_OAUTH_AUDIENCE: string;
CAMUNDA_SECURE_CONNECTION: boolean;
CAMUNDA_TASKLIST_BASE_URL: undefined | string;
CAMUNDA_TASKLIST_OAUTH_AUDIENCE: string;
CAMUNDA_TENANT_ID: undefined | string;
CAMUNDA_TOKEN_CACHE_DIR: undefined | string;
CAMUNDA_TOKEN_DISK_CACHE_DISABLE: boolean;
CAMUNDA_TOKEN_SCOPE: undefined | string;
CAMUNDA_ZEEBE_OAUTH_AUDIENCE: string;
ZEEBE_ADDRESS: string;
ZEEBE_CLIENT_ID: undefined | string;
ZEEBE_CLIENT_SECRET: undefined | string;
zeebeGrpcSettings: {
GRPC_HTTP2_MAX_PINGS_WITHOUT_DATA: number;
GRPC_HTTP2_MIN_PING_INTERVAL_WITHOUT_DATA_MS: number;
GRPC_HTTP2_MIN_TIME_BETWEEN_PINGS_MS: number;
GRPC_INITIAL_RECONNECT_BACKOFF_MS: string | number;
GRPC_KEEPALIVE_PERMIT_WITHOUT_CALLS: number;
GRPC_KEEPALIVE_TIMEOUT_MS: number;
GRPC_KEEPALIVE_TIME_MS: number;
GRPC_MAX_RECONNECT_BACKOFF_MS: string | number;
GRPC_MIN_RECONNECT_BACKOFF_MS: string | number;
ZEEBE_CLIENT_LOG_LEVEL: string;
ZEEBE_CLIENT_LOG_TYPE: string;
ZEEBE_GRPC_CLIENT_CONNECTION_TOLERANCE_MS: number;
ZEEBE_GRPC_CLIENT_EAGER_CONNECT: boolean;
ZEEBE_GRPC_CLIENT_INITIAL_CONNECTION_TOLERANCE_MS: undefined | number;
ZEEBE_GRPC_CLIENT_MAX_RETRIES: number;
ZEEBE_GRPC_CLIENT_MAX_RETRY_TIMEOUT_SECONDS: number;
ZEEBE_GRPC_CLIENT_RETRY: boolean;
ZEEBE_GRPC_WORKER_LONGPOLL_SECONDS: number;
ZEEBE_GRPC_WORKER_POLL_INTERVAL_MS: number;
};
}
CAMUNDA_CONSOLE_BASE_URL: undefined | string;
CAMUNDA_CONSOLE_CLIENT_ID: undefined | string;
CAMUNDA_CONSOLE_CLIENT_SECRET: undefined | string;
CAMUNDA_CONSOLE_OAUTH_AUDIENCE: string;
CAMUNDA_CUSTOM_CERT_CHAIN_PATH: undefined | string;
CAMUNDA_CUSTOM_PRIVATE_KEY_PATH: undefined | string;
CAMUNDA_CUSTOM_ROOT_CERT_PATH: undefined | string;
CAMUNDA_CUSTOM_USER_AGENT_STRING: undefined | string;
CAMUNDA_MODELER_BASE_URL: string;
CAMUNDA_MODELER_OAUTH_AUDIENCE: undefined | string;
CAMUNDA_OAUTH_DISABLED: boolean;
CAMUNDA_OAUTH_TOKEN_REFRESH_THRESHOLD_MS: number;
CAMUNDA_OAUTH_URL: undefined | string;
CAMUNDA_OPERATE_BASE_URL: undefined | string;
CAMUNDA_OPERATE_OAUTH_AUDIENCE: string;
CAMUNDA_OPTIMIZE_BASE_URL: undefined | string;
CAMUNDA_OPTIMIZE_OAUTH_AUDIENCE: string;
CAMUNDA_SECURE_CONNECTION: boolean;
CAMUNDA_TASKLIST_BASE_URL: undefined | string;
CAMUNDA_TASKLIST_OAUTH_AUDIENCE: string;
CAMUNDA_TENANT_ID: undefined | string;
CAMUNDA_TOKEN_CACHE_DIR: undefined | string;
CAMUNDA_TOKEN_DISK_CACHE_DISABLE: boolean;
CAMUNDA_TOKEN_SCOPE: undefined | string;
CAMUNDA_ZEEBE_OAUTH_AUDIENCE: string;
ZEEBE_ADDRESS: string;
ZEEBE_CLIENT_ID: undefined | string;
ZEEBE_CLIENT_SECRET: undefined | string;
zeebeGrpcSettings: {
GRPC_HTTP2_MAX_PINGS_WITHOUT_DATA: number;
GRPC_HTTP2_MIN_PING_INTERVAL_WITHOUT_DATA_MS: number;
GRPC_HTTP2_MIN_TIME_BETWEEN_PINGS_MS: number;
GRPC_INITIAL_RECONNECT_BACKOFF_MS: string | number;
GRPC_KEEPALIVE_PERMIT_WITHOUT_CALLS: number;
GRPC_KEEPALIVE_TIMEOUT_MS: number;
GRPC_KEEPALIVE_TIME_MS: number;
GRPC_MAX_RECONNECT_BACKOFF_MS: string | number;
GRPC_MIN_RECONNECT_BACKOFF_MS: string | number;
ZEEBE_CLIENT_LOG_LEVEL: string;
ZEEBE_CLIENT_LOG_TYPE: string;
ZEEBE_GRPC_CLIENT_CONNECTION_TOLERANCE_MS: number;
ZEEBE_GRPC_CLIENT_EAGER_CONNECT: boolean;
ZEEBE_GRPC_CLIENT_INITIAL_CONNECTION_TOLERANCE_MS: undefined | number;
ZEEBE_GRPC_CLIENT_MAX_RETRIES: number;
ZEEBE_GRPC_CLIENT_MAX_RETRY_TIMEOUT_SECONDS: number;
ZEEBE_GRPC_CLIENT_RETRY: boolean;
ZEEBE_GRPC_WORKER_LONGPOLL_SECONDS: number;
ZEEBE_GRPC_WORKER_POLL_INTERVAL_MS: number;
};
}
Type declaration
CAMUNDA_
CONSOLE_ BASE_ URL: undefined | string The base url for the Admin Console API.
-CAMUNDA_
CONSOLE_ CLIENT_ ID: undefined | string Credentials for Admin Console and Modeler API
-CAMUNDA_
CONSOLE_ CLIENT_ SECRET: undefined | string Credentials for Admin Console and Modeler API
-CAMUNDA_
CONSOLE_ OAUTH_ AUDIENCE: string The audience parameter for an Admin Console OAuth token request. Defaults to api.cloud.camunda.io when connecting to Camunda SaaS, and '' otherwise
-CAMUNDA_
CUSTOM_ CERT_ CHAIN_ PATH: undefined | string When using custom or self-signed certificates, provide the path to the certificate chain
-CAMUNDA_
CUSTOM_ PRIVATE_ KEY_ PATH: undefined | string When using custom or self-signed certificates, provide the path to the private key
-CAMUNDA_
CUSTOM_ ROOT_ CERT_ PATH: undefined | string In an environment using self-signed certificates, provide the path to the root certificate
-CAMUNDA_
CUSTOM_ USER_ AGENT_ STRING: undefined | string Custom user agent
-CAMUNDA_
MODELER_ BASE_ URL: string The base url for the Modeler API. Defaults to Camunda Saas - https://modeler.cloud.camunda.io/api
-CAMUNDA_
MODELER_ OAUTH_ AUDIENCE: undefined | string The audience parameter for a Modeler OAuth token request. Defaults to api.cloud.camunda.io when connecting to Camunda SaaS, and '' otherwise
-CAMUNDA_
OAUTH_ DISABLED: boolean Set to true to disable OAuth completely
-CAMUNDA_
OAUTH_ TOKEN_ REFRESH_ THRESHOLD_ MS: number How soon in milliseconds before its expiration time a cached OAuth token should be considered expired. Defaults to 1000
-CAMUNDA_
OAUTH_ URL: undefined | string The OAuth token exchange endpoint url
-CAMUNDA_
OPERATE_ BASE_ URL: undefined | string The base url for the Operate API
-CAMUNDA_
OPERATE_ OAUTH_ AUDIENCE: string The audience parameter for an Operate OAuth token request. Defaults to operate.camunda.io
-CAMUNDA_
OPTIMIZE_ BASE_ URL: undefined | string The base url for the Optimize API
-CAMUNDA_
OPTIMIZE_ OAUTH_ AUDIENCE: string The audience parameter for an Optimize OAuth token request. Defaults to optimize.camunda.io
-CAMUNDA_
SECURE_ CONNECTION: boolean Control TLS for Zeebe Grpc. Defaults to true. Set to false when using an unsecured gateway
-CAMUNDA_
TASKLIST_ BASE_ URL: undefined | string The base url for the Tasklist API
-CAMUNDA_
TASKLIST_ OAUTH_ AUDIENCE: string The audience parameter for a Tasklist OAuth token request. Defaults to tasklist.camunda.io
-CAMUNDA_
TENANT_ ID: undefined | string The tenant id when multi-tenancy is enabled
-CAMUNDA_
TOKEN_ CACHE_ DIR: undefined | string The directory to cache OAuth tokens on-disk. Defaults to $HOME/.camunda
-CAMUNDA_
TOKEN_ DISK_ CACHE_ DISABLE: boolean Set to true to disable disk caching of OAuth tokens and use memory caching only
-CAMUNDA_
TOKEN_ SCOPE: undefined | string Optional scope parameter for OAuth (needed by some OIDC)
-CAMUNDA_
ZEEBE_ OAUTH_ AUDIENCE: string The audience parameter for a Zeebe OAuth token request. Defaults to zeebe.camunda.io
-ZEEBE_
ADDRESS: string The address for the Zeebe Gateway. Defaults to localhost:26500
-ZEEBE_
CLIENT_ ID: undefined | string This is the client ID for the client credentials
-ZEEBE_
CLIENT_ SECRET: undefined | string This is the client secret for the client credentials
-zeebe
Grpc Settings: {
GRPC_HTTP2_MAX_PINGS_WITHOUT_DATA: number;
GRPC_HTTP2_MIN_PING_INTERVAL_WITHOUT_DATA_MS: number;
GRPC_HTTP2_MIN_TIME_BETWEEN_PINGS_MS: number;
GRPC_INITIAL_RECONNECT_BACKOFF_MS: string | number;
GRPC_KEEPALIVE_PERMIT_WITHOUT_CALLS: number;
GRPC_KEEPALIVE_TIMEOUT_MS: number;
GRPC_KEEPALIVE_TIME_MS: number;
GRPC_MAX_RECONNECT_BACKOFF_MS: string | number;
GRPC_MIN_RECONNECT_BACKOFF_MS: string | number;
ZEEBE_CLIENT_LOG_LEVEL: string;
ZEEBE_CLIENT_LOG_TYPE: string;
ZEEBE_GRPC_CLIENT_CONNECTION_TOLERANCE_MS: number;
ZEEBE_GRPC_CLIENT_EAGER_CONNECT: boolean;
ZEEBE_GRPC_CLIENT_INITIAL_CONNECTION_TOLERANCE_MS: undefined | number;
ZEEBE_GRPC_CLIENT_MAX_RETRIES: number;
ZEEBE_GRPC_CLIENT_MAX_RETRY_TIMEOUT_SECONDS: number;
ZEEBE_GRPC_CLIENT_RETRY: boolean;
ZEEBE_GRPC_WORKER_LONGPOLL_SECONDS: number;
ZEEBE_GRPC_WORKER_POLL_INTERVAL_MS: number;
}GRPC_
HTTP2_ MAX_ PINGS_ WITHOUT_ DATA: number This channel argument controls the maximum number -of pings that can be sent when there is no other -data (data frame or header frame) to be sent. -GRPC Core will not continue sending pings if we -run over the limit. Setting it to 0 allows sending -pings without sending data.
-GRPC_
HTTP2_ MIN_ PING_ INTERVAL_ WITHOUT_ DATA_ MS: number Minimum allowed time between a server receiving -successive ping frames without sending any data -frame. Int valued, milliseconds. Default: 90000
-GRPC_
HTTP2_ MIN_ TIME_ BETWEEN_ PINGS_ MS: number Defaults to 90000.
-GRPC_
INITIAL_ RECONNECT_ BACKOFF_ MS: string | number The time between the first and second connection attempts, -in ms. Defaults to 1000.
-GRPC_
KEEPALIVE_ PERMIT_ WITHOUT_ CALLS: number This channel argument if set to 1 -(0 : false; 1 : true), allows keepalive pings -to be sent even if there are no calls in flight. -Defaults to 1.
-GRPC_
KEEPALIVE_ TIMEOUT_ MS: number After waiting for a duration of this time, if the keepalive ping sender does not receive the ping ack, it will close the -transport. Int valued, milliseconds. Defaults to 120000.
-GRPC_
KEEPALIVE_ TIME_ MS: number After a duration of this time the client/server pings its peer to see if the transport is still alive. -Int valued, milliseconds. Defaults to 360000.
-GRPC_
MAX_ RECONNECT_ BACKOFF_ MS: string | number The maximum time between subsequent connection attempts, -in ms. Defaults to 10000.
-GRPC_
MIN_ RECONNECT_ BACKOFF_ MS: string | number The minimum time between subsequent connection attempts, -in ms. Default is 1000ms, but this can cause an SSL Handshake failure. -This causes an intermittent failure in the Worker-LongPoll test when run -against Camunda Cloud. -Raised to 5000ms. -See: https://github.com/grpc/grpc/issues/8382#issuecomment-259482949
-ZEEBE_
CLIENT_ LOG_ LEVEL: string Log level of Zeebe Client and Workers - 'DEBUG' | 'INFO' | 'NONE'. Defaults to 'INFO'
-ZEEBE_
CLIENT_ LOG_ TYPE: string Zeebe client log output can be human-readable 'SIMPLE' or structured 'JSON'. Defaults to 'SIMPLE'
-ZEEBE_
GRPC_ CLIENT_ CONNECTION_ TOLERANCE_ MS: number The gRPC channel can "jitter". This suppresses a connection error message if the channel comes back within this window in milliseconds. Defaults to 3000
-ZEEBE_
GRPC_ CLIENT_ EAGER_ CONNECT: boolean Immediately connect to the Zeebe Gateway (issues a silent topology request). Defaults to false
-ZEEBE_
GRPC_ CLIENT_ INITIAL_ CONNECTION_ TOLERANCE_ MS: undefined | number This suppresses intermediate errors during initial connection negotiation. On Camunda SaaS this defaults to 6000, on Self-Managed to 0
-ZEEBE_
GRPC_ CLIENT_ MAX_ RETRIES: number Maximum number of retries of network operations before failing. Defaults to -1 (infinite retries)
-ZEEBE_
GRPC_ CLIENT_ MAX_ RETRY_ TIMEOUT_ SECONDS: number When retrying failed network operations, retries back off to this maximum period. Defaults to 10s
-ZEEBE_
GRPC_ CLIENT_ RETRY: boolean Automate retrying operations that fail due to network conditions or broker backpressure. Defaults to true
-ZEEBE_
GRPC_ WORKER_ LONGPOLL_ SECONDS: number How long in seconds the long poll Job Activation request is held open by a worker. Defaults to 60
-ZEEBE_
GRPC_ WORKER_ POLL_ INTERVAL_ MS: number After a long poll Job Activation request, this is the cool-off period in milliseconds before the worker requests more work. Defaults to 300
-
Optional connected
connected?: boolean = undefined
connection
connection
Private Optional customSSL
gateway
gateway
Private grpc
Private logger
loglevel
Private max
max
Private max
max
Private o
Optional on
on
Type declaration
- (err): void
Parameters
- err: Error
Returns void
Optional on
on
Type declaration
- (): void
Returns void
Private options
readied
readied: boolean = false
Private retry
retry: boolean
Private stdout
Private Optional tenant
tenant
Private useTLS
useTLS: boolean
Private worker
worker
Private workers
Methods
Private _on
activate
- activate
Jobs<Variables, CustomHeaders>(request): Promise<Job<Variables, CustomHeaders>[]> Type Parameters
- Variables = IInputVariables
- CustomHeaders = ICustomHeaders
Parameters
- request: ActivateJobsRequest & {
customHeadersDto?: (new (...args) => Readonly<CustomHeaders>);
inputVariableDto?: (new (...args) => Readonly<Variables>);
}
Returns Promise<Job<Variables, CustomHeaders>[]>
Description
activateJobs allows you to manually activate jobs, effectively building a worker; rather than using the ZBWorker class.
-Example
-const zbc = new ZeebeGrpcClient()
zbc.activateJobs({
maxJobsToActivate: 5,
requestTimeout: 6000,
timeout: 5 * 60 * 1000,
type: 'process-payment',
worker: 'my-worker-uuid'
}).then(jobs =>
jobs.forEach(job =>
// business logic
zbc.completeJob({
jobKey: job.key,
variables: {}
))
)
}) -
broadcast
- broadcast
Signal(req): Promise<BroadcastSignalRes> Parameters
- req: BroadcastSignalReq
Returns Promise<BroadcastSignalRes>
Description
Broadcast a Signal
-Example
-const zbc = new ZeebeGrpcClient()
zbc.broadcastSignal({
signalName: 'my-signal',
variables: { reasonCode: 3 }
}) -
cancel
- cancel
Process Instance(processInstanceKey): Promise<void> Parameters
- processInstanceKey: string | number
Returns Promise<void>
Description
Cancel a process instance by process instance key.
-Example
-const zbc = new ZeebeGrpcClient()
zbc.cancelProcessInstance(processInstanceId)
.catch(
(e: any) => console.log(`Error cancelling instance: ${e.message}`)
) -
close
- close(timeout?): Promise<null>
Parameters
Optionaltimeout: number
Returns Promise<null>
Description
Gracefully shut down all workers, draining existing tasks, and return when it is safe to exit.
-Example
-const zbc = new ZeebeGrpcClient()
zbc.createWorker({
taskType:
})
setTimeout(async () => {
await zbc.close()
console.log('All work completed.')
}),
5 * 60 * 1000 // 5 mins
) -
complete
- complete
Job(completeJobRequest): Promise<void> Parameters
- completeJobRequest: CompleteJobRequest<IProcessVariables>
Returns Promise<void>
Description
Explicitly complete a job. The method is useful for manually constructing a worker.
-Example
-const zbc = new ZeebeGrpcClient()
zbc.activateJobs({
maxJobsToActivate: 5,
requestTimeout: 6000,
timeout: 5 * 60 * 1000,
type: 'process-payment',
worker: 'my-worker-uuid'
}).then(jobs =>
jobs.forEach(job =>
// business logic
zbc.completeJob({
jobKey: job.key,
variables: {}
))
)
}) -
Private construct
- construct
Grpc Client(__namedParameters): {
grpcClient: ZBGrpc;
log: StatefulLogInterceptor;
} Parameters
- __namedParameters: {
grpcConfig: {
namespace: string;
onConnectionError?: (() => void);
onReady?: (() => void);
tasktype?: string;
};
logConfig: ZBLoggerConfig;
}grpc
Config: {
namespace: string;
onConnectionError?: (() => void);
onReady?: (() => void);
tasktype?: string;
}namespace: string
OptionalonConnection Error?: (() => void) - (): void
Returns void
OptionalonReady?: (() => void) - (): void
Returns void
Optionaltasktype?: string
log
Config: ZBLoggerConfig
Returns {
grpcClient: ZBGrpc;
log: StatefulLogInterceptor;
}grpc
Client: ZBGrpc log: StatefulLogInterceptor
- __namedParameters: {
create
- create
Process Instance<Variables>(config): Promise<CreateProcessInstanceResponse> Type Parameters
- Variables extends JSONDoc = IProcessVariables
Parameters
- config: CreateProcessInstanceReq<Variables>
Returns Promise<CreateProcessInstanceResponse>
Description
Create a new process instance. Asynchronously returns a process instance id.
-Example
-const zbc = new ZeebeGrpcClient()
zbc.createProcessInstance({
bpmnProcessId: 'onboarding-process',
variables: {
customerId: 'uuid-3455'
},
version: 5 // optional, will use latest by default
}).then(res => console.log(JSON.stringify(res, null, 2)))
zbc.createProcessInstance({
bpmnProcessId: 'SkipFirstTask',
variables: { id: random },
startInstructions: [{elementId: 'second_service_task'}]
}).then(res => (id = res.processInstanceKey)) -
create
- create
Process Instance With Result<Variables, Result>(config): Promise<CreateProcessInstanceWithResultResponse<Result>> Type Parameters
- Variables extends JSONDoc = IProcessVariables
- Result = IOutputVariables
Parameters
Returns Promise<CreateProcessInstanceWithResultResponse<Result>>
Description
Create a process instance, and return a Promise that returns the outcome of the process.
-Example
-const zbc = new ZeebeGrpcClient()
zbc.createProcessInstanceWithResult({
bpmnProcessId: 'order-process',
variables: {
customerId: 123,
invoiceId: 567
}
})
.then(console.log) -
create
- create
Worker<WorkerInputVariables, CustomHeaderShape, WorkerOutputVariables>(config): ZBWorker<WorkerInputVariables, CustomHeaderShape, WorkerOutputVariables> Type Parameters
- WorkerInputVariables = IInputVariables
- CustomHeaderShape = ICustomHeaders
- WorkerOutputVariables = IOutputVariables
Parameters
Returns ZBWorker<WorkerInputVariables, CustomHeaderShape, WorkerOutputVariables>
Description
Create a worker that polls the gateway for jobs and executes a job handler when units of work are available.
-Example
-const zbc = new ZB.ZeebeGrpcClient()
const zbWorker = zbc.createWorker({
taskType: 'demo-service',
taskHandler: myTaskHandler,
})
// A job handler must return one of job.complete, job.fail, job.error, or job.forward
// Note: unhandled exceptions in the job handler cause the library to call job.fail
async function myTaskHandler(job) {
zbWorker.log('Task variables', job.variables)
// Task worker business logic goes here
const updateToBrokerVariables = {
updatedProperty: 'newValue',
}
const res = await callExternalSystem(job.variables)
if (res.code === 'SUCCESS') {
return job.complete({
...updateToBrokerVariables,
...res.values
})
}
if (res.code === 'BUSINESS_ERROR') {
return job.error({
code: res.errorCode,
message: res.message
})
}
if (res.code === 'ERROR') {
return job.fail({
errorMessage: res.message,
retryBackOff: 2000
})
}
} -
delete
- delete
Resource(resourceId): Promise<Record<string, never>> Delete a resource.
-Parameters
- resourceId: {
resourceKey: string;
}The key of the resource that should be deleted. This can either be the key of a process definition, the key of a decision requirements definition or the key of a form.
-resource
Key: string
Returns Promise<Record<string, never>>
- resourceId: {
deploy
- deploy
Resource(resource): Promise<DeployResourceResponse<ProcessDeployment>> Parameters
- resource: {
processFilename: string;
tenantId?: string;
} | {
name: string;
process: Buffer;
tenantId?: string;
}
Returns Promise<DeployResourceResponse<ProcessDeployment>>
Description
Deploys one or more resources (e.g. processes or decision models) to Zeebe. -Note that this is an atomic call, i.e. either all resources are deployed, or none of them are.
-Errors: -PERMISSION_DENIED:
--
-
- if a deployment to an unauthorized tenant is performed -INVALID_ARGUMENT: -
- no resources given. -
- if at least one resource is invalid. A resource is considered invalid if:
-
-
- the content is not deserializable (e.g. detected as BPMN, but it's broken XML) -
- the content is invalid (e.g. an event-based gateway has an outgoing sequence flow to a task) -
- - if multi-tenancy is enabled, and:
-
-
- a tenant id is not provided -
- a tenant id with an invalid format is provided -
- - if multi-tenancy is disabled and a tenant id is provided -
Example
-import {join} from 'path'
const zbc = new ZeebeGrpcClient()
zbc.deployResource({ processFilename: join(process.cwd(), 'bpmn', 'onboarding.bpmn' })
zbc.deployResource({ decisionFilename: join(process.cwd(), 'dmn', 'approval.dmn')}) -- resource: {
- deploy
Resource(resource): Promise<DeployResourceResponse<DecisionDeployment>> Parameters
- resource: {
decisionFilename: string;
tenantId?: string;
} | {
decision: Buffer;
name: string;
tenantId?: string;
}
Returns Promise<DeployResourceResponse<DecisionDeployment>>
- resource: {
- deploy
Resource(resource): Promise<DeployResourceResponse<FormDeployment>> Parameters
- resource: {
formFilename: string;
tenantId?: string;
} | {
form: Buffer;
name: string;
tenantId?: string;
}
Returns Promise<DeployResourceResponse<FormDeployment>>
- resource: {
emit
evaluate
- evaluate
Decision(evaluateDecisionRequest): Promise<EvaluateDecisionResponse> Parameters
- evaluateDecisionRequest: EvaluateDecisionRequest
Returns Promise<EvaluateDecisionResponse>
Description
Evaluates a decision. The decision to evaluate can be specified either by using its unique key (as returned by DeployResource), or using the decision ID. When using the decision ID, the latest deployed version of the decision is used.
-Example
-const zbc = new ZeebeGrpcClient()
zbc.evaluateDecision({
decisionId: 'my-decision',
variables: { season: "Fall" }
}).then(res => console.log(JSON.stringify(res, null, 2))) -
Private execute
- execute
Operation<T>(operationName, operation, retries?): Promise<T> If this.retry is set true, the operation will be wrapped in an configurable retry on exceptions -of gRPC error code 14 - Transient Network Failure. -See: https://github.com/grpc/grpc/blob/master/doc/statuscodes.md -If this.retry is false, it will be executed with no retry, and the application should handle the exception.
-Type Parameters
Parameters
Returns Promise<T>
fail
- fail
Job(failJobRequest): Promise<void> Parameters
- failJobRequest: FailJobRequest
Returns Promise<void>
Description
Fail a job. This is useful if you are using the decoupled completion pattern or building your own worker. -For the retry count, the current count is available in the job metadata.
-Example
-const zbc = new ZeebeGrpcClient()
zbc.failJob( {
jobKey: '345424343451',
retries: 3,
errorMessage: 'Could not get a response from the order invoicing API',
retryBackOff: 30 * 1000 // optional, otherwise available for reactivation immediately
}) -
get
- get
Service Types From Bpmn(files): Promise<string[]> Parameters
- files: string | string[]
Returns Promise<string[]>
Description
Return an array of task types contained in a BPMN file or array of BPMN files. This can be useful, for example, to do
-Example
-const zbc = new ZeebeGrpcClient()
zbc.getServiceTypesFromBpmn(['bpmn/onboarding.bpmn', 'bpmn/process-sale.bpmn'])
.then(tasktypes => console.log('The task types are:', tasktypes))
-
modify
- modify
Process Instance(modifyProcessInstanceRequest): Promise<ModifyProcessInstanceResponse> Parameters
- modifyProcessInstanceRequest: ModifyProcessInstanceRequest
Returns Promise<ModifyProcessInstanceResponse>
Description
Modify a running process instance. This allows you to move the execution tokens, and change the variables. Added in 8.1. -See the gRPC protocol documentation.
-Example
-zbc.createProcessInstance('SkipFirstTask', {}).then(res =>
zbc.modifyProcessInstance({
processInstanceKey: res.processInstanceKey,
activateInstructions: [{
elementId: 'second_service_task',
ancestorElementInstanceKey: "-1",
variableInstructions: [{
scopeId: '',
variables: { second: 1}
}]
}]
})
) -
off
- off<K>(eventName, fn): void
Type Parameters
- K extends EventKey<{
close: "close";
connectionError: "connectionError";
ready: "ready";
unknown: "unknown";
}>
Parameters
- eventName: K
- fn: EventReceiver
Returns void
- K extends EventKey<{
on
- on<K>(eventName, fn): ZeebeGrpcClient
Type Parameters
- K extends EventKey<{
close: "close";
connectionError: "connectionError";
ready: "ready";
unknown: "unknown";
}>
Parameters
- eventName: K
- fn: EventReceiver
Returns ZeebeGrpcClient
- K extends EventKey<{
publish
- publish
Message<ProcessVariables>(publishMessageRequest): Promise<PublishMessageResponse> Type Parameters
- ProcessVariables extends {
[key: string]: JSON;
} = IProcessVariables
Parameters
- publishMessageRequest: PublishMessageRequest<ProcessVariables>
Returns Promise<PublishMessageResponse>
Description
Publish a message to the broker for correlation with a workflow instance. See this tutorial for a detailed description of message correlation.
-Example
-const zbc = new ZeebeGrpcClient()
zbc.publishMessage({
// Should match the "Message Name" in a BPMN Message Catch
name: 'order_status',
correlationKey: 'uuid-124-532-5432',
variables: {
event: 'PROCESSED'
}
}) -- ProcessVariables extends {
publish
- publish
Start Message<ProcessVariables>(publishStartMessageRequest): Promise<PublishMessageResponse> Type Parameters
- ProcessVariables extends IInputVariables = IProcessVariables
Parameters
- publishStartMessageRequest: PublishStartMessageRequest<ProcessVariables>
Returns Promise<PublishMessageResponse>
Description
Publish a message to the broker for correlation with a workflow message start event. -For a message targeting a start event, the correlation key is not needed to target a specific running process instance. -However, the hash of the correlationKey is used to determine the partition where this workflow will start. -So we assign a random uuid to balance workflow instances created via start message across partitions.
-We make the correlationKey optional, because the caller can specify a correlationKey + messageId -to guarantee an idempotent message.
-Multiple messages with the same correlationKey + messageId combination will only start a workflow once. -See: https://github.com/zeebe-io/zeebe/issues/1012 and https://github.com/zeebe-io/zeebe/issues/1022
-Example
-const zbc = new ZeebeGrpcClient()
zbc.publishStartMessage({
name: 'Start_New_Onboarding_Flow',
variables: {
customerId: 'uuid-348-234-8908'
}
})
// To do the same in an idempotent fashion - note: only idempotent during the lifetime of the created instance.
zbc.publishStartMessage({
name: 'Start_New_Onboarding_Flow',
messageId: 'uuid-348-234-8908', // use customerId to make process idempotent per customer
variables: {
customerId: 'uuid-348-234-8908'
}
}) -
remove
resolve
- resolve
Incident(resolveIncidentRequest): Promise<void> Parameters
- resolveIncidentRequest: ResolveIncidentRequest
Returns Promise<void>
Description
Resolve an incident by incident key.
-Example
-type JSONObject = {[key: string]: string | number | boolean | JSONObject}
const zbc = new ZeebeGrpcClient()
async updateAndResolveIncident({
processInstanceId,
incidentKey,
variables
} : {
processInstanceId: string,
incidentKey: string,
variables: JSONObject
}) {
await zbc.setVariables({
elementInstanceKey: processInstanceId,
variables
})
await zbc.updateRetries()
zbc.resolveIncident({
incidentKey
})
zbc.resolveIncident(incidentKey)
}
-
Private retry
- retry
On Failure<T>(operationName, operation, retries?): Promise<T> This function takes a gRPC operation that returns a Promise as a function, and invokes it. -If the operation throws gRPC error 14, this function will continue to try it until it succeeds -or retries are exhausted.
-Type Parameters
Parameters
Returns Promise<T>
set
- set
Variables<Variables>(request): Promise<void> Type Parameters
- Variables = IProcessVariables
Parameters
- request: SetVariablesRequest<Variables>
Returns Promise<void>
Description
Directly modify the variables is a process instance. This can be used with
-resolveIncidentto update the process and resolve an incident.Example
-type JSONObject = {[key: string]: string | number | boolean | JSONObject}
const zbc = new ZeebeGrpcClient()
async function updateAndResolveIncident({
incidentKey,
processInstanceKey,
jobKey,
variableUpdate
} : {
incidentKey: string
processInstanceKey: string
jobKey: string
variableUpdate: JSONObject
}) {
await zbc.setVariables({
elementInstanceKey: processInstanceKey,
variables: variableUpdate
})
await zbc.updateJobRetries({
jobKey,
retries: 1
})
return zbc.resolveIncident({
incidentKey
})
} -
throw
- throw
Error(throwErrorRequest): Promise<void> Parameters
- throwErrorRequest: ThrowErrorRequest
Returns Promise<void>
Description
Fail a job by throwing a business error (i.e. non-technical) that occurs while processing a job. -The error is handled in the workflow by an error catch event. -If there is no error catch event with the specified
-errorCodethen an incident will be raised instead. -This method is useful when building a worker, for example for the decoupled completion pattern.Example
-type JSONObject = {[key: string]: string | number | boolean | JSONObject}
interface errorResult {
resultType: 'ERROR' as 'ERROR'
errorCode: string
errorMessage: string
}
interface successResult {
resultType: 'SUCCESS' as 'SUCCESS'
variableUpdate: JSONObject
}
type Result = errorResult | successResult
const zbc = new ZeebeGrpcClient()
// This could be a listener on a return queue from an external system
async function handleJob(jobKey: string, result: Result) {
if (resultType === 'ERROR') {
const { errorMessage, errorCode } = result
zbc.throwError({
jobKey,
errorCode,
errorMessage
})
} else {
zbc.completeJob({
jobKey,
variables: result.variableUpdate
})
}
} -
topology
- topology(): Promise<TopologyResponse>
Returns Promise<TopologyResponse>
Description
Return the broker cluster topology.
-Example
-const zbc = new ZeebeGrpcClient()
zbc.topology().then(res => console.res(JSON.stringify(res, null, 2))) -
update
- update
Job Retries(updateJobRetriesRequest): Promise<void> Parameters
- updateJobRetriesRequest: UpdateJobRetriesRequest
Returns Promise<void>
Description
Update the number of retries for a Job. This is useful if a job has zero remaining retries and fails, raising an incident.
-Example
-type JSONObject = {[key: string]: string | number | boolean | JSONObject}
const zbc = new ZeebeGrpcClient()
async function updateAndResolveIncident({
incidentKey,
processInstanceKey,
jobKey,
variableUpdate
} : {
incidentKey: string
processInstanceKey: string
jobKey: string
variableUpdate: JSONObject
}) {
await zbc.setVariables({
elementInstanceKey: processInstanceKey,
variables: variableUpdate
})
await zbc.updateJobRetries({
jobKey,
retries: 1
})
return zbc.resolveIncident({
incidentKey
})
} -
Generated using TypeDoc
Class LosslessDto
Extend the LosslessDto class with your own Dto classes to enable lossless parsing of int64 values.
-Decorate fields with @Int64String or @BigIntValue to specify how int64 JSON numbers should be parsed.
Example
class MyDto extends LosslessDto {
@Int64String
int64NumberField: string
@BigIntValue
bigintField: bigint
@ChildDto(MyChildDto)
childDtoField: MyChildDto
normalField: string
normalNumberField: number
}
-Hierarchy (view full)
Index
Constructors
Constructors
constructor
- new
Lossless Dto(obj): LosslessDto Parameters
- obj: any
Returns LosslessDto
Generated using TypeDoc
Class StatefulLogInterceptor
Index
Constructors
Properties
Methods
Constructors
constructor
- new
Stateful Log Interceptor(__namedParameters): StatefulLogInterceptor Parameters
- __namedParameters: {
characteristics: Characteristics;
logConfig: ZBLoggerConfig;
}characteristics: Characteristics
log
Config: ZBLoggerConfig
Returns StatefulLogInterceptor
- __namedParameters: {
Properties
blocking
blocking: boolean
Private Optional blocking
blocking
characteristics
Private error
error: ((msg) => void) = ...
Type declaration
- (msg): void
Parameters
- msg: string
Returns void
errors
errors: never[] = []
Private info
info: ((msg) => void) = ...
Type declaration
- (msg): void
Parameters
- msg: string
Returns void
initial
initial
log
logs
logs: never[] = []
state
Methods
close
connection
Private empty
Private empty
log
log
log
log
ready
Private wrap
- wrap(store): ((logmethod) => ((msg) => void))
Parameters
- store: string[]
Returns ((logmethod) => ((msg) => void))
- (logmethod): ((msg) => void)
Parameters
- logmethod: ((msg, ...optionalParameters) => void)
- (msg, ...optionalParameters): void
Parameters
- msg: string
Rest...optionalParameters: unknown[]
Returns void
Returns ((msg) => void)
- (msg): void
Parameters
- msg: string
Returns void
- logmethod: ((msg, ...optionalParameters) => void)
Generated using TypeDoc
Class TypedEmitter<T>
Type Parameters
- T extends EventMap
Hierarchy (view full)
- TypedEmitter
Implements
Index
Constructors
constructor
- new
Typed Emitter<T>(): TypedEmitter<T> Type Parameters
- T extends EventMap
Returns TypedEmitter<T>
Properties
Private emitter
emitter: EventEmitter = ...
Methods
emit
- emit<K>(eventName, params?): void
Type Parameters
Returns void
off
- off<K>(eventName, fn): void
Type Parameters
Parameters
- eventName: K
- fn: EventReceiver
Returns void
on
- on<K>(eventName, fn): TypedEmitter<T>
Type Parameters
Parameters
- eventName: K
- fn: EventReceiver
Returns TypedEmitter<T>
remove
Generated using TypeDoc
Class ZBLogger
Constructors
constructor
- new ZBLogger(__namedParameters): ZBLogger
Parameters
- __namedParameters: ZBLoggerConfig
Returns ZBLogger
Properties
_tag
_tag: "ZBCLIENT" | "ZBWORKER"
Private color
Private colorise
colorise: boolean
Private Optional id
id?: string
loglevel
Private namespace
namespace: undefined | string
Private Optional poll
poll
Private stdout
Private Optional task
task
Methods
Private _colorise
debug
error
info
log
Private make
Generated using TypeDoc
Class ZBWorkerBase<WorkerInputVariables, CustomHeaderShape, WorkerOutputVariables>
Type Parameters
Hierarchy (view full)
- TypedEmitter<typeof ConnectionStatusEvent>
- ZBWorkerBase
Index
Constructors
Properties
active
Methods
Constructors
constructor
- new ZBWorker
Base<WorkerInputVariables, CustomHeaderShape, WorkerOutputVariables>(__namedParameters): ZBWorkerBase<WorkerInputVariables, CustomHeaderShape, WorkerOutputVariables> Type Parameters
Parameters
- __namedParameters: ZBWorkerConstructorConfig<WorkerInputVariables, CustomHeaderShape, WorkerOutputVariables>
Returns ZBWorkerBase<WorkerInputVariables, CustomHeaderShape, WorkerOutputVariables>
Properties
active
active
Private active
active
Private back
back
Protected cancel
cancel
Private capacity
capacity
Private Optional close
close
Type declaration
- (): void
Returns void
Private Optional close
close
Private closed
closed: boolean = false
Private closing
closing: boolean = false
Private connected
connected: boolean = true
Private custom
Type declaration
- new (...args): CustomHeaderShape
Parameters
Rest...args: any[]
Returns CustomHeaderShape
Private debug
debug
Private fetch
grpc
Private id
id: string = ...
Private input
Type declaration
- new (obj): WorkerInputVariables
Parameters
- obj: any
Returns WorkerInputVariables
Private Optional job
job
Protected logger
Private long
long
max
max
poll
poll
Private poll
poll
Private poll
poll
Private poll
poll
Private readied
readied: boolean = false
Private stalled
stalled: boolean = false
Protected task
task
task
Private Optional tenant
tenant
timeout
timeout: MaybeTimeDuration
Protected zb
Static Private Readonly DEFAULT_
DEFAULT_
Static Private Readonly DEFAULT_
DEFAULT_
Methods
Private activate
- activate
Jobs(id): Promise<{
closing?: undefined;
error?: undefined;
stalled: true;
stream: undefined;
} | {
closing: true;
error?: undefined;
stalled?: undefined;
stream: undefined;
} | {
closing?: undefined;
error: Error;
stalled?: undefined;
stream: undefined;
} | {
closing?: undefined;
error?: undefined;
stalled?: undefined;
stream: {} & {} & EmitterAugmentation1<"metadata", Metadata> & EmitterAugmentation1<"status", StatusObject> & EventEmitter & {} & EmitterAugmentation1<"data", unknown> & IntermediateObjectReadable<unknown> & {
error?: Error;
};
}> Parameters
- id: string
Returns Promise<{
closing?: undefined;
error?: undefined;
stalled: true;
stream: undefined;
} | {
closing: true;
error?: undefined;
stalled?: undefined;
stream: undefined;
} | {
closing?: undefined;
error: Error;
stalled?: undefined;
stream: undefined;
} | {
closing?: undefined;
error?: undefined;
stalled?: undefined;
stream: {} & {} & EmitterAugmentation1<"metadata", Metadata> & EmitterAugmentation1<"status", StatusObject> & EventEmitter & {} & EmitterAugmentation1<"data", unknown> & IntermediateObjectReadable<unknown> & {
error?: Error;
};
}>
close
Private complete
debug
- debug(msg): void
Parameters
- msg: JSON
Returns void
Protected drain
emit
error
- error(msg): void
Parameters
- msg: JSON
Returns void
Private error
- error
Job(__namedParameters): Promise<"JOB_ACTION_ACKNOWLEDGEMENT"> Parameters
- __namedParameters: {
errorCode: string;
errorMessage: string;
job: Job<WorkerInputVariables, CustomHeaderShape>;
variables: JSONDoc;
}error
Code: string error
Message: string job: Job<WorkerInputVariables, CustomHeaderShape>
variables: JSONDoc
Returns Promise<"JOB_ACTION_ACKNOWLEDGEMENT">
- __namedParameters: {
Private fail
- fail
Job(__namedParameters): Promise<"JOB_ACTION_ACKNOWLEDGEMENT"> Parameters
- __namedParameters: {
errorMessage: string;
job: Job<WorkerInputVariables, CustomHeaderShape>;
retries?: number;
retryBackOff?: number;
}error
Message: string job: Job<WorkerInputVariables, CustomHeaderShape>
Optionalretries?: numberOptionalretryBack Off?: number
Returns Promise<"JOB_ACTION_ACKNOWLEDGEMENT">
- __namedParameters: {
Private handle
- handle
Job Response(res): void Parameters
- res: ActivateJobsResponse
Returns void
Protected handle
- handle
Jobs(jobs): void Parameters
- jobs: Job<WorkerInputVariables, CustomHeaderShape>[]
Returns void
Private handle
log
- log(msg): void
Parameters
- msg: JSON
Returns void
Protected make
- make
Complete Handlers<T>(thisJob): JobCompletionInterface<T> Type Parameters
Parameters
- thisJob: Job<WorkerInputVariables, CustomHeaderShape>
Returns JobCompletionInterface<T>
off
- off<K>(eventName, fn): void
Type Parameters
- K extends EventKey<{
close: "close";
connectionError: "connectionError";
ready: "ready";
unknown: "unknown";
}>
Parameters
- eventName: K
- fn: EventReceiver
Returns void
- K extends EventKey<{
on
- on<K>(eventName, fn): ZBWorkerBase<WorkerInputVariables, CustomHeaderShape, WorkerOutputVariables>
Type Parameters
- K extends EventKey<{
close: "close";
connectionError: "connectionError";
ready: "ready";
unknown: "unknown";
}>
Parameters
- eventName: K
- fn: EventReceiver
Returns ZBWorkerBase<WorkerInputVariables, CustomHeaderShape, WorkerOutputVariables>
- K extends EventKey<{
Private poll
remove
Generated using TypeDoc
Class GrpcClient
Hierarchy (view full)
- EventEmitter
- GrpcClient
Index
Constructors
Properties
Methods
Constructors
constructor
- new
Grpc Client(__namedParameters): GrpcClient Parameters
- __namedParameters: GrpcClientCtor
Returns GrpcClient
Properties
channel
channel
Private channel
channel
client
client: Client
Private closing
closing: boolean = false
Private config
config: {
CAMUNDA_CONSOLE_BASE_URL: undefined | string;
CAMUNDA_CONSOLE_CLIENT_ID: undefined | string;
CAMUNDA_CONSOLE_CLIENT_SECRET: undefined | string;
CAMUNDA_CONSOLE_OAUTH_AUDIENCE: string;
CAMUNDA_CUSTOM_CERT_CHAIN_PATH: undefined | string;
CAMUNDA_CUSTOM_PRIVATE_KEY_PATH: undefined | string;
CAMUNDA_CUSTOM_ROOT_CERT_PATH: undefined | string;
CAMUNDA_CUSTOM_USER_AGENT_STRING: undefined | string;
CAMUNDA_MODELER_BASE_URL: string;
CAMUNDA_MODELER_OAUTH_AUDIENCE: undefined | string;
CAMUNDA_OAUTH_DISABLED: boolean;
CAMUNDA_OAUTH_TOKEN_REFRESH_THRESHOLD_MS: number;
CAMUNDA_OAUTH_URL: undefined | string;
CAMUNDA_OPERATE_BASE_URL: undefined | string;
CAMUNDA_OPERATE_OAUTH_AUDIENCE: string;
CAMUNDA_OPTIMIZE_BASE_URL: undefined | string;
CAMUNDA_OPTIMIZE_OAUTH_AUDIENCE: string;
CAMUNDA_SECURE_CONNECTION: boolean;
CAMUNDA_TASKLIST_BASE_URL: undefined | string;
CAMUNDA_TASKLIST_OAUTH_AUDIENCE: string;
CAMUNDA_TENANT_ID: undefined | string;
CAMUNDA_TOKEN_CACHE_DIR: undefined | string;
CAMUNDA_TOKEN_DISK_CACHE_DISABLE: boolean;
CAMUNDA_TOKEN_SCOPE: undefined | string;
CAMUNDA_ZEEBE_OAUTH_AUDIENCE: string;
ZEEBE_ADDRESS: string;
ZEEBE_CLIENT_ID: undefined | string;
ZEEBE_CLIENT_SECRET: undefined | string;
zeebeGrpcSettings: {
GRPC_HTTP2_MAX_PINGS_WITHOUT_DATA: number;
GRPC_HTTP2_MIN_PING_INTERVAL_WITHOUT_DATA_MS: number;
GRPC_HTTP2_MIN_TIME_BETWEEN_PINGS_MS: number;
GRPC_INITIAL_RECONNECT_BACKOFF_MS: string | number;
GRPC_KEEPALIVE_PERMIT_WITHOUT_CALLS: number;
GRPC_KEEPALIVE_TIMEOUT_MS: number;
GRPC_KEEPALIVE_TIME_MS: number;
GRPC_MAX_RECONNECT_BACKOFF_MS: string | number;
GRPC_MIN_RECONNECT_BACKOFF_MS: string | number;
ZEEBE_CLIENT_LOG_LEVEL: string;
ZEEBE_CLIENT_LOG_TYPE: string;
ZEEBE_GRPC_CLIENT_CONNECTION_TOLERANCE_MS: number;
ZEEBE_GRPC_CLIENT_EAGER_CONNECT: boolean;
ZEEBE_GRPC_CLIENT_INITIAL_CONNECTION_TOLERANCE_MS: undefined | number;
ZEEBE_GRPC_CLIENT_MAX_RETRIES: number;
ZEEBE_GRPC_CLIENT_MAX_RETRY_TIMEOUT_SECONDS: number;
ZEEBE_GRPC_CLIENT_RETRY: boolean;
ZEEBE_GRPC_WORKER_LONGPOLL_SECONDS: number;
ZEEBE_GRPC_WORKER_POLL_INTERVAL_MS: number;
};
}
CAMUNDA_CONSOLE_BASE_URL: undefined | string;
CAMUNDA_CONSOLE_CLIENT_ID: undefined | string;
CAMUNDA_CONSOLE_CLIENT_SECRET: undefined | string;
CAMUNDA_CONSOLE_OAUTH_AUDIENCE: string;
CAMUNDA_CUSTOM_CERT_CHAIN_PATH: undefined | string;
CAMUNDA_CUSTOM_PRIVATE_KEY_PATH: undefined | string;
CAMUNDA_CUSTOM_ROOT_CERT_PATH: undefined | string;
CAMUNDA_CUSTOM_USER_AGENT_STRING: undefined | string;
CAMUNDA_MODELER_BASE_URL: string;
CAMUNDA_MODELER_OAUTH_AUDIENCE: undefined | string;
CAMUNDA_OAUTH_DISABLED: boolean;
CAMUNDA_OAUTH_TOKEN_REFRESH_THRESHOLD_MS: number;
CAMUNDA_OAUTH_URL: undefined | string;
CAMUNDA_OPERATE_BASE_URL: undefined | string;
CAMUNDA_OPERATE_OAUTH_AUDIENCE: string;
CAMUNDA_OPTIMIZE_BASE_URL: undefined | string;
CAMUNDA_OPTIMIZE_OAUTH_AUDIENCE: string;
CAMUNDA_SECURE_CONNECTION: boolean;
CAMUNDA_TASKLIST_BASE_URL: undefined | string;
CAMUNDA_TASKLIST_OAUTH_AUDIENCE: string;
CAMUNDA_TENANT_ID: undefined | string;
CAMUNDA_TOKEN_CACHE_DIR: undefined | string;
CAMUNDA_TOKEN_DISK_CACHE_DISABLE: boolean;
CAMUNDA_TOKEN_SCOPE: undefined | string;
CAMUNDA_ZEEBE_OAUTH_AUDIENCE: string;
ZEEBE_ADDRESS: string;
ZEEBE_CLIENT_ID: undefined | string;
ZEEBE_CLIENT_SECRET: undefined | string;
zeebeGrpcSettings: {
GRPC_HTTP2_MAX_PINGS_WITHOUT_DATA: number;
GRPC_HTTP2_MIN_PING_INTERVAL_WITHOUT_DATA_MS: number;
GRPC_HTTP2_MIN_TIME_BETWEEN_PINGS_MS: number;
GRPC_INITIAL_RECONNECT_BACKOFF_MS: string | number;
GRPC_KEEPALIVE_PERMIT_WITHOUT_CALLS: number;
GRPC_KEEPALIVE_TIMEOUT_MS: number;
GRPC_KEEPALIVE_TIME_MS: number;
GRPC_MAX_RECONNECT_BACKOFF_MS: string | number;
GRPC_MIN_RECONNECT_BACKOFF_MS: string | number;
ZEEBE_CLIENT_LOG_LEVEL: string;
ZEEBE_CLIENT_LOG_TYPE: string;
ZEEBE_GRPC_CLIENT_CONNECTION_TOLERANCE_MS: number;
ZEEBE_GRPC_CLIENT_EAGER_CONNECT: boolean;
ZEEBE_GRPC_CLIENT_INITIAL_CONNECTION_TOLERANCE_MS: undefined | number;
ZEEBE_GRPC_CLIENT_MAX_RETRIES: number;
ZEEBE_GRPC_CLIENT_MAX_RETRY_TIMEOUT_SECONDS: number;
ZEEBE_GRPC_CLIENT_RETRY: boolean;
ZEEBE_GRPC_WORKER_LONGPOLL_SECONDS: number;
ZEEBE_GRPC_WORKER_POLL_INTERVAL_MS: number;
};
}
Type declaration
CAMUNDA_
CONSOLE_ BASE_ URL: undefined | string The base url for the Admin Console API.
-CAMUNDA_
CONSOLE_ CLIENT_ ID: undefined | string Credentials for Admin Console and Modeler API
-CAMUNDA_
CONSOLE_ CLIENT_ SECRET: undefined | string Credentials for Admin Console and Modeler API
-CAMUNDA_
CONSOLE_ OAUTH_ AUDIENCE: string The audience parameter for an Admin Console OAuth token request. Defaults to api.cloud.camunda.io when connecting to Camunda SaaS, and '' otherwise
-CAMUNDA_
CUSTOM_ CERT_ CHAIN_ PATH: undefined | string When using custom or self-signed certificates, provide the path to the certificate chain
-CAMUNDA_
CUSTOM_ PRIVATE_ KEY_ PATH: undefined | string When using custom or self-signed certificates, provide the path to the private key
-CAMUNDA_
CUSTOM_ ROOT_ CERT_ PATH: undefined | string In an environment using self-signed certificates, provide the path to the root certificate
-CAMUNDA_
CUSTOM_ USER_ AGENT_ STRING: undefined | string Custom user agent
-CAMUNDA_
MODELER_ BASE_ URL: string The base url for the Modeler API. Defaults to Camunda Saas - https://modeler.cloud.camunda.io/api
-CAMUNDA_
MODELER_ OAUTH_ AUDIENCE: undefined | string The audience parameter for a Modeler OAuth token request. Defaults to api.cloud.camunda.io when connecting to Camunda SaaS, and '' otherwise
-CAMUNDA_
OAUTH_ DISABLED: boolean Set to true to disable OAuth completely
-CAMUNDA_
OAUTH_ TOKEN_ REFRESH_ THRESHOLD_ MS: number How soon in milliseconds before its expiration time a cached OAuth token should be considered expired. Defaults to 1000
-CAMUNDA_
OAUTH_ URL: undefined | string The OAuth token exchange endpoint url
-CAMUNDA_
OPERATE_ BASE_ URL: undefined | string The base url for the Operate API
-CAMUNDA_
OPERATE_ OAUTH_ AUDIENCE: string The audience parameter for an Operate OAuth token request. Defaults to operate.camunda.io
-CAMUNDA_
OPTIMIZE_ BASE_ URL: undefined | string The base url for the Optimize API
-CAMUNDA_
OPTIMIZE_ OAUTH_ AUDIENCE: string The audience parameter for an Optimize OAuth token request. Defaults to optimize.camunda.io
-CAMUNDA_
SECURE_ CONNECTION: boolean Control TLS for Zeebe Grpc. Defaults to true. Set to false when using an unsecured gateway
-CAMUNDA_
TASKLIST_ BASE_ URL: undefined | string The base url for the Tasklist API
-CAMUNDA_
TASKLIST_ OAUTH_ AUDIENCE: string The audience parameter for a Tasklist OAuth token request. Defaults to tasklist.camunda.io
-CAMUNDA_
TENANT_ ID: undefined | string The tenant id when multi-tenancy is enabled
-CAMUNDA_
TOKEN_ CACHE_ DIR: undefined | string The directory to cache OAuth tokens on-disk. Defaults to $HOME/.camunda
-CAMUNDA_
TOKEN_ DISK_ CACHE_ DISABLE: boolean Set to true to disable disk caching of OAuth tokens and use memory caching only
-CAMUNDA_
TOKEN_ SCOPE: undefined | string Optional scope parameter for OAuth (needed by some OIDC)
-CAMUNDA_
ZEEBE_ OAUTH_ AUDIENCE: string The audience parameter for a Zeebe OAuth token request. Defaults to zeebe.camunda.io
-ZEEBE_
ADDRESS: string The address for the Zeebe Gateway. Defaults to localhost:26500
-ZEEBE_
CLIENT_ ID: undefined | string This is the client ID for the client credentials
-ZEEBE_
CLIENT_ SECRET: undefined | string This is the client secret for the client credentials
-zeebe
Grpc Settings: {
GRPC_HTTP2_MAX_PINGS_WITHOUT_DATA: number;
GRPC_HTTP2_MIN_PING_INTERVAL_WITHOUT_DATA_MS: number;
GRPC_HTTP2_MIN_TIME_BETWEEN_PINGS_MS: number;
GRPC_INITIAL_RECONNECT_BACKOFF_MS: string | number;
GRPC_KEEPALIVE_PERMIT_WITHOUT_CALLS: number;
GRPC_KEEPALIVE_TIMEOUT_MS: number;
GRPC_KEEPALIVE_TIME_MS: number;
GRPC_MAX_RECONNECT_BACKOFF_MS: string | number;
GRPC_MIN_RECONNECT_BACKOFF_MS: string | number;
ZEEBE_CLIENT_LOG_LEVEL: string;
ZEEBE_CLIENT_LOG_TYPE: string;
ZEEBE_GRPC_CLIENT_CONNECTION_TOLERANCE_MS: number;
ZEEBE_GRPC_CLIENT_EAGER_CONNECT: boolean;
ZEEBE_GRPC_CLIENT_INITIAL_CONNECTION_TOLERANCE_MS: undefined | number;
ZEEBE_GRPC_CLIENT_MAX_RETRIES: number;
ZEEBE_GRPC_CLIENT_MAX_RETRY_TIMEOUT_SECONDS: number;
ZEEBE_GRPC_CLIENT_RETRY: boolean;
ZEEBE_GRPC_WORKER_LONGPOLL_SECONDS: number;
ZEEBE_GRPC_WORKER_POLL_INTERVAL_MS: number;
}GRPC_
HTTP2_ MAX_ PINGS_ WITHOUT_ DATA: number This channel argument controls the maximum number -of pings that can be sent when there is no other -data (data frame or header frame) to be sent. -GRPC Core will not continue sending pings if we -run over the limit. Setting it to 0 allows sending -pings without sending data.
-GRPC_
HTTP2_ MIN_ PING_ INTERVAL_ WITHOUT_ DATA_ MS: number Minimum allowed time between a server receiving -successive ping frames without sending any data -frame. Int valued, milliseconds. Default: 90000
-GRPC_
HTTP2_ MIN_ TIME_ BETWEEN_ PINGS_ MS: number Defaults to 90000.
-GRPC_
INITIAL_ RECONNECT_ BACKOFF_ MS: string | number The time between the first and second connection attempts, -in ms. Defaults to 1000.
-GRPC_
KEEPALIVE_ PERMIT_ WITHOUT_ CALLS: number This channel argument if set to 1 -(0 : false; 1 : true), allows keepalive pings -to be sent even if there are no calls in flight. -Defaults to 1.
-GRPC_
KEEPALIVE_ TIMEOUT_ MS: number After waiting for a duration of this time, if the keepalive ping sender does not receive the ping ack, it will close the -transport. Int valued, milliseconds. Defaults to 120000.
-GRPC_
KEEPALIVE_ TIME_ MS: number After a duration of this time the client/server pings its peer to see if the transport is still alive. -Int valued, milliseconds. Defaults to 360000.
-GRPC_
MAX_ RECONNECT_ BACKOFF_ MS: string | number The maximum time between subsequent connection attempts, -in ms. Defaults to 10000.
-GRPC_
MIN_ RECONNECT_ BACKOFF_ MS: string | number The minimum time between subsequent connection attempts, -in ms. Default is 1000ms, but this can cause an SSL Handshake failure. -This causes an intermittent failure in the Worker-LongPoll test when run -against Camunda Cloud. -Raised to 5000ms. -See: https://github.com/grpc/grpc/issues/8382#issuecomment-259482949
-ZEEBE_
CLIENT_ LOG_ LEVEL: string Log level of Zeebe Client and Workers - 'DEBUG' | 'INFO' | 'NONE'. Defaults to 'INFO'
-ZEEBE_
CLIENT_ LOG_ TYPE: string Zeebe client log output can be human-readable 'SIMPLE' or structured 'JSON'. Defaults to 'SIMPLE'
-ZEEBE_
GRPC_ CLIENT_ CONNECTION_ TOLERANCE_ MS: number The gRPC channel can "jitter". This suppresses a connection error message if the channel comes back within this window in milliseconds. Defaults to 3000
-ZEEBE_
GRPC_ CLIENT_ EAGER_ CONNECT: boolean Immediately connect to the Zeebe Gateway (issues a silent topology request). Defaults to false
-ZEEBE_
GRPC_ CLIENT_ INITIAL_ CONNECTION_ TOLERANCE_ MS: undefined | number This suppresses intermediate errors during initial connection negotiation. On Camunda SaaS this defaults to 6000, on Self-Managed to 0
-ZEEBE_
GRPC_ CLIENT_ MAX_ RETRIES: number Maximum number of retries of network operations before failing. Defaults to -1 (infinite retries)
-ZEEBE_
GRPC_ CLIENT_ MAX_ RETRY_ TIMEOUT_ SECONDS: number When retrying failed network operations, retries back off to this maximum period. Defaults to 10s
-ZEEBE_
GRPC_ CLIENT_ RETRY: boolean Automate retrying operations that fail due to network conditions or broker backpressure. Defaults to true
-ZEEBE_
GRPC_ WORKER_ LONGPOLL_ SECONDS: number How long in seconds the long poll Job Activation request is held open by a worker. Defaults to 60
-ZEEBE_
GRPC_ WORKER_ POLL_ INTERVAL_ MS: number After a long poll Job Activation request, this is the cool-off period in milliseconds before the worker requests more work. Defaults to 300
-
connected
connected: boolean = false
Private connection
connection
Private Optional fail
fail
Private gRPCRetry
gRPCRetry
host
host: string
Private list
list
Optional long
long
Private Optional o
Private package
package
Private Optional ready
ready
Private user
user
Methods
close
Private get
Private interceptor
list
run
Private set
Private set
Private wait
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
@camunda8/sdk
Camunda 8 JavaScript SDK
This is the official Camunda 8 JavaScript SDK. It is written in TypeScript and runs on NodeJS (why not in a web browser?).
-Using the SDK in your project
Install the SDK as a dependency:
-npm i @camunda8/sdk
-Usage
In this release, the functionality of the Camunda Platform 8 is exposed via dedicated clients for the component APIs.
-import { Camunda8 } from '@camunda8/sdk'
const c8 = new Camunda8()
const zeebe = c8.getZeebeGrpcClient()
const operate = c8.getOperateApiClient()
const optimize = c8.getOptimizeApiClient()
const tasklist = c8.getTasklistApiClient()
const modeler = c8.getModelerApiClient()
const admin = c8.getAdminApiClient()
-Configuration
The configuration for the SDK can be done by any combination of environment variables and explicit configuration passed to the Camunda8 constructor.
Any configuration passed in to the Camunda8 constructor is merged over any configuration in the environment.
The configuration object fields and the environment variables have exactly the same names. See the file src/lib/Configuration.ts for a complete list of configuration.
A note on how int64 is handled in the JavaScript SDK
Entity keys in Camunda 8 are stored and represented as int64 numbers. The range of int64 extends to numbers that cannot be represented by the JavaScript number type. To deal with this, int64 keys are serialised by the SDK to the JavaScript string type. See this issue for more details.
Some number values - for example: "total returned results " - may be specified as int64 in the API specifications. Although these numbers will usually not contain unsafe values, they are always serialised to string.
For int64 values whose type is not known ahead of time, such as job variables, you can pass an annotated Dto object to decode them reliably. If no Dto is specified, the default behaviour of the SDK is to serialise all numbers to JavaScript number, and if a number value is detected at runtime that cannot be accurately stored as number, to throw an Exception.
OAuth
Calls to APIs are authorized using a token that is obtained via a client id/secret pair exchange and then passes as an authorisation header on API calls. The SDK handles this transparently for you.
-If your Camunda 8 Platform is secured using token exchange you will need to provide the client id and secret to the SDK.
-Disable OAuth
To disable OAuth, set the environment variable CAMUNDA_OAUTH_DISABLED. You can use this when, for example, running against a minimal Zeebe broker in a development environment.
With this environment variable set, the SDK will inject a NullAuthProvider that does nothing.
Configuring OAuth
To get a token for use with the application APIs you need to provide the following configuration fields at a minimum, either via the Camunda8 constructor or in environment variables:
ZEEBE_ADDRESS
ZEEBE_CLIENT_ID
ZEEBE_CLIENT_SECRET
CAMUNDA_OAUTH_URL
-To get a token for the Camunda SaaS Admin Console API or the Camunda SaaS Modeler API you need to set the following:
-CAMUNDA_CONSOLE_CLIENT_ID
CAMUNDA_CONSOLE_CLIENT_SECRET
-Token caching
OAuth tokens are cached in-memory and on-disk. The disk cache is useful, for example, to prevent token endpoint saturation when restarting or rolling over workers. They can all hit the cache instead of requesting new tokens.
-You can turn off the disk caching by setting CAMUNDA_TOKEN_DISK_CACHE_DISABLE to true. This will cache tokens in-memory only.
By default the token cache directory is $HOME/.camunda. You can specify a different directory by providing a full file path value for CAMUNDA_TOKEN_CACHE_DIR.
Here is an example of specifying a different cache directory via the constructor:
-import { Camunda8 } from '@camunda8/sdk'
const c8 = new Camunda8({
config: {
CAMUNDA_TOKEN_CACHE_DIR: '/tmp/cache',
},
})
-If the cache directory does not exist, the SDK will attempt to create it (recursively). If the SDK is unable to create it, or the directory exists but is not writeable by your application then the SDK will throw an exception.
-Token refresh
Token refresh timing relative to expiration is controlled by the CAMUNDA_OAUTH_TOKEN_REFRESH_THRESHOLD_MS value. By default this is 1000ms. Tokens are renewed this amount of time before they expire.
If you experience intermittent 401: Unauthorized errors, this may not be sufficient time to refresh the token before it expires in your infrastructure. Increase this value to force a token to be refreshed before it expires.
Connection Configuration Examples
Self-Managed
This is the complete environment configuration needed to run against the Dockerised Self-Managed Stack in the docker subdirectory:
# Self-Managed
export ZEEBE_ADDRESS='localhost:26500'
export ZEEBE_CLIENT_ID='zeebe'
export ZEEBE_CLIENT_SECRET='zecret'
export CAMUNDA_OAUTH_URL='http://localhost:18080/auth/realms/camunda-platform/protocol/openid-connect/token'
export CAMUNDA_TASKLIST_BASE_URL='http://localhost:8082'
export CAMUNDA_OPERATE_BASE_URL='http://localhost:8081'
export CAMUNDA_OPTIMIZE_BASE_URL='http://localhost:8083'
export CAMUNDA_MODELER_BASE_URL='http://localhost:8070/api'
# Turn off the tenant ID, which may have been set by Multi-tenant tests
# You can set this in a constructor config, or in the environment if running multi-tenant
export CAMUNDA_TENANT_ID=''
# TLS for gRPC is on by default. If the Zeebe broker is not secured by TLS, turn it off
export CAMUNDA_SECURE_CONNECTION=false
-If you are using an OIDC that requires a scope parameter to be passed with the token request, set the following variable:
CAMUNDA_TOKEN_SCOPE
-Here is an example of doing this via the constructor, rather than via the environment:
-import { Camunda8 } from '@camunda8/sdk'
const c8 = new Camunda8({
config: {
ZEEBE_ADDRESS: 'localhost:26500'
ZEEBE_CLIENT_ID: 'zeebe'
ZEEBE_CLIENT_SECRET: 'zecret'
CAMUNDA_OAUTH_URL: 'http://localhost:18080/auth/realms/camunda-platform/protocol/openid-connect/token'
CAMUNDA_TASKLIST_BASE_URL: 'http://localhost:8082'
CAMUNDA_OPERATE_BASE_URL: 'http://localhost:8081'
CAMUNDA_OPTIMIZE_BASE_URL: 'http://localhost:8083'
CAMUNDA_MODELER_BASE_URL: 'http://localhost:8070/api'
CAMUNDA_TENANT_ID: '' // We can override values in the env by passing an empty string value
CAMUNDA_SECURE_CONNECTION: false
}
})
-Camunda SaaS
Here is a complete configuration example for connection to Camunda SaaS:
-export ZEEBE_ADDRESS='5c34c0a7-7f29-4424-8414-125615f7a9b9.syd-1.zeebe.camunda.io:443'
export ZEEBE_CLIENT_ID='yvvURO9TmBnP3zx4Xd8Ho6apgeiZTjn6'
export ZEEBE_CLIENT_SECRET='iJJu-SHgUtuJTTAMnMLdcb8WGF8s2mHfXhXutEwe8eSbLXn98vUpoxtuLk5uG0en'
# export CAMUNDA_CREDENTIALS_SCOPES='Zeebe,Tasklist,Operate,Optimize' # What APIs these client creds are authorised for
export CAMUNDA_TASKLIST_BASE_URL='https://syd-1.tasklist.camunda.io/5c34c0a7-7f29-4424-8414-125615f7a9b9'
export CAMUNDA_OPTIMIZE_BASE_URL='https://syd-1.optimize.camunda.io/5c34c0a7-7f29-4424-8414-125615f7a9b9'
export CAMUNDA_OPERATE_BASE_URL='https://syd-1.operate.camunda.io/5c34c0a7-7f29-4424-8414-125615f7a9b9'
export CAMUNDA_OAUTH_URL='https://login.cloud.camunda.io/oauth/token'
# This is on by default, but we include it in case it got turned off for local tests
export CAMUNDA_SECURE_CONNECTION=true
# Admin Console and Modeler API Client
export CAMUNDA_CONSOLE_CLIENT_ID='e-JdgKfJy9hHSXzi'
export CAMUNDA_CONSOLE_CLIENT_SECRET='DT8Pe-ANC6e3Je_ptLyzZvBNS0aFwaIV'
export CAMUNDA_CONSOLE_BASE_URL='https://api.cloud.camunda.io'
export CAMUNDA_CONSOLE_OAUTH_AUDIENCE='api.cloud.camunda.io'
-Debugging
The SDK uses the debug library. To enable debugging output, set a value for the DEBUG environment variable. The value is a comma-separated list of debugging namespaces. The SDK has the following namespaces:
| Value | -Component | -
|---|---|
camunda:adminconsole |
-Admin Console API | -
camunda:modeler |
-Modeler API | -
camunda:operate |
-Operate API | -
camunda:optimize |
-Optimize API | -
camunda:tasklist |
-Tasklist API | -
camunda:oauth |
-OAuth Token Exchange | -
camunda:grpc |
-Zeebe gRPC channel | -
camunda:worker |
-Zeebe Worker | -
camunda:zeebeclient |
-Zeebe Client | -
Typing of Zeebe Worker Variables
The variable payload in a Zeebe Worker task handler is available as an object job.variables. By default, this is of type any.
The ZBClient.createWorker() method accepts an inputVariableDto to control the parsing of number values and provide design-time type information. Passing an inputVariableDto class to a Zeebe worker is optional. If a Dto class is passed to the Zeebe Worker, it is used for two purposes:
-
-
- To provide design-time type information on the
job.variablesobject.
- - To specify the parsing of JSON number fields. These can potentially represent
int64values that cannot be represented accurately by the JavaScriptnumbertype. With a Dto, you can specify that a specific JSON number fields be parsed losslessly to astringorBigInt.
-
With no Dto specified, there is no design-time type safety. At run-time, all JSON numbers are converted to the JavaScript number type. If a variable field has a number value that cannot be safely represented using the JavaScript number type (a value greater than 2^53 -1) then an exception is thrown.
To provide a Dto, extend the LosslessDto class, like so:
class MyVariableDto extends LosslessDto {
name!: string
maybeAge?: number
@Int64String
veryBigNumber!: string
@BigIntValue
veryBigInteger!: bigint
}
-In this case, veryBigNumber is an int64 value. It is transferred as a JSON number on the wire, but the parser will parse it into a string so that no loss of precision occurs. Similarly, veryBigInteger is a very large integer value. In this case, we direct the parser to parse this variable field as a bigint.
You can nest Dtos like this:
-class MyLargerDto extends LosslessDto {
id!: string
@ChildDto(MyVariableDto)
entry!: MyVariableDto
}
-Typing of Custom Headers
The Zeebe worker receives custom headers as job.customHeaders. The ZBClient.createWorker() method accepts a customHeadersDto to control the behaviour of custom header parsing of number values and provide design-time type information.
This follows the same strategy as the job variables, as previously described.
-Generated using TypeDoc
Interface Cluster
interface Cluster {
channel: {
name: string;
uuid: string;
};
created: string;
generation: {
name: string;
uuid: string;
};
links: {
connectors: string;
console: string;
operate: string;
optimize: string;
tasklist: string;
zeebe: string;
};
name: string;
ownerId: string;
planType: {
name: string;
uuid: string;
};
region: {
name: string;
uuid: string;
};
status: {
operateStatus: ClusterStatusstring;
optimizeStatus: ClusterStatusstring;
ready: ClusterStatusstring;
tasklistStatus: ClusterStatusstring;
zeebeStatus: ClusterStatusstring;
};
uuid: string;
}
channel: {
name: string;
uuid: string;
};
created: string;
generation: {
name: string;
uuid: string;
};
links: {
connectors: string;
console: string;
operate: string;
optimize: string;
tasklist: string;
zeebe: string;
};
name: string;
ownerId: string;
planType: {
name: string;
uuid: string;
};
region: {
name: string;
uuid: string;
};
status: {
operateStatus: ClusterStatusstring;
optimizeStatus: ClusterStatusstring;
ready: ClusterStatusstring;
tasklistStatus: ClusterStatusstring;
zeebeStatus: ClusterStatusstring;
};
uuid: string;
}
Properties
channel
channel: {
name: string;
uuid: string;
}
name: string;
uuid: string;
}
Type declaration
name: string
uuid: string
created
created: string
generation
generation: {
name: string;
uuid: string;
}
name: string;
uuid: string;
}
Type declaration
name: string
uuid: string
links
links: {
connectors: string;
console: string;
operate: string;
optimize: string;
tasklist: string;
zeebe: string;
}
connectors: string;
console: string;
operate: string;
optimize: string;
tasklist: string;
zeebe: string;
}
Type declaration
connectors: string
console: string
operate: string
optimize: string
tasklist: string
zeebe: string
name
name: string
owner
owner
plan
plan
name: string;
uuid: string;
}
name: string;
uuid: string;
}
Type declaration
name: string
uuid: string
region
region: {
name: string;
uuid: string;
}
name: string;
uuid: string;
}
Type declaration
name: string
uuid: string
status
status: {
operateStatus: ClusterStatusstring;
optimizeStatus: ClusterStatusstring;
ready: ClusterStatusstring;
tasklistStatus: ClusterStatusstring;
zeebeStatus: ClusterStatusstring;
}
operateStatus: ClusterStatusstring;
optimizeStatus: ClusterStatusstring;
ready: ClusterStatusstring;
tasklistStatus: ClusterStatusstring;
zeebeStatus: ClusterStatusstring;
}
Type declaration
operate
Status: ClusterStatusstring optimize
Status: ClusterStatusstring ready: ClusterStatusstring
tasklist
Status: ClusterStatusstring zeebe
Status: ClusterStatusstring
uuid
uuid: string
Generated using TypeDoc
Interface ClusterClient
interface ClusterClient {
clientId: string;
name: string;
permissions: ("Zeebe" | "Operate" | "Tasklist")[];
}
clientId: string;
name: string;
permissions: ("Zeebe" | "Operate" | "Tasklist")[];
}
Index
Properties
Properties
client
client
name
name: string
permissions
permissions: ("Zeebe" | "Operate" | "Tasklist")[]
Generated using TypeDoc
Interface ClusterClientConnectionDetails
interface ClusterClientConnectionDetails {
ZEEBE_ADDRESS: string;
ZEEBE_AUTHORIZATION_SERVER_URL: string;
ZEEBE_CLIENT_ID: string;
name: string;
}
ZEEBE_ADDRESS: string;
ZEEBE_AUTHORIZATION_SERVER_URL: string;
ZEEBE_CLIENT_ID: string;
name: string;
}
Index
Properties
Properties
ZEEBE_
ZEEBE_
ZEEBE_
ZEEBE_
ZEEBE_
ZEEBE_
name
name: string
Generated using TypeDoc
Interface CreateClusterBody
interface CreateClusterBody {
channelId: string;
generationId: string;
name: string;
planTypeId: string;
regionId: string;
}
channelId: string;
generationId: string;
name: string;
planTypeId: string;
regionId: string;
}
Index
Properties
Properties
channel
channel
generation
generation
name
name: string
plan
plan
region
region
Generated using TypeDoc
Generated using TypeDoc
Interface Member
interface Member {
email: string;
invitePending: boolean;
name: string;
roles: OrganizationRole[];
}
email: string;
invitePending: boolean;
name: string;
roles: OrganizationRole[];
}
Index
Properties
Properties
email: string
invite
invite
name
name: string
roles
Generated using TypeDoc
Interface Parameters
interface Parameters {
channels: [{
allowedGenerations: [{
name: string;
uuid: string;
}];
defaultGeneration: {
name: string;
uuid: string;
};
name: string;
uuid: string;
}];
clusterPlanTypes: [{
name: string;
uuid: string;
}];
regions: [{
name: string;
uuid: string;
}];
}
channels: [{
allowedGenerations: [{
name: string;
uuid: string;
}];
defaultGeneration: {
name: string;
uuid: string;
};
name: string;
uuid: string;
}];
clusterPlanTypes: [{
name: string;
uuid: string;
}];
regions: [{
name: string;
uuid: string;
}];
}
Index
Properties
Properties
channels
channels: [{
allowedGenerations: [{
name: string;
uuid: string;
}];
defaultGeneration: {
name: string;
uuid: string;
};
name: string;
uuid: string;
}]
allowedGenerations: [{
name: string;
uuid: string;
}];
defaultGeneration: {
name: string;
uuid: string;
};
name: string;
uuid: string;
}]
Type declaration
allowed
Generations: [{
name: string;
uuid: string;
}]default
Generation: {
name: string;
uuid: string;
}name: string
uuid: string
name: string
uuid: string
cluster
cluster
name: string;
uuid: string;
}]
name: string;
uuid: string;
}]
Type declaration
name: string
uuid: string
regions
regions: [{
name: string;
uuid: string;
}]
name: string;
uuid: string;
}]
Type declaration
name: string
uuid: string
Generated using TypeDoc
Interface IOAuthProvider
Implemented by
Index
Methods
get
Methods
get
- get
Token(audience): Promise<string> Parameters
- audience: TokenGrantAudienceType
Returns Promise<string>
Generated using TypeDoc
Interface Token
interface Token {
access_token: string;
audience: string;
expires_in: number;
expiry: number;
scope: string;
token_type: string;
}
access_token: string;
audience: string;
expires_in: number;
expiry: number;
scope: string;
token_type: string;
}
Index
Properties
Properties
access_
access_
audience
audience: string
expires_
expires_
expiry
expiry: number
scope
scope: string
token_
token_
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Interface CreateFileDto
interface CreateFileDto {
content: string;
fileType: string;
folderId: string;
name: string;
pattern: "form" | "bpmn" | "dmn" | "connector_template";
projectId: string;
}
content: string;
fileType: string;
folderId: string;
name: string;
pattern: "form" | "bpmn" | "dmn" | "connector_template";
projectId: string;
}
Properties
content
content: string
file
file
folder
folder
maxLength: 255, minLength: 1
-name
name: string
maxLength: 255, minLength: 1
-pattern
pattern: "form" | "bpmn" | "dmn" | "connector_template"
project
project
maxLength: 255, minLength: 1
-Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Interface FileMetadataDto
interface FileMetadataDto {
canonicalPath: PathElementDto[];
created: string;
createdBy: UserDto;
folderId: string;
id: string;
name: string;
projectId: string;
revision: number;
simplePath: string;
type: string;
updated: string;
updatedBy: UserDto;
}
canonicalPath: PathElementDto[];
created: string;
createdBy: UserDto;
folderId: string;
id: string;
name: string;
projectId: string;
revision: number;
simplePath: string;
type: string;
updated: string;
updatedBy: UserDto;
}
Properties
canonical
created
created: string
created
folder
folder
id
id: string
name
name: string
project
project
revision
revision: number
simple
simple
type
type: string
updated
updated: string
updated
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Interface FolderMetadataDto
interface FolderMetadataDto {
created: string;
createdBy: UserDto;
id: string;
name: string;
parentId: string;
projectId: string;
updated: string;
updatedBy: UserDto;
}
created: string;
createdBy: UserDto;
id: string;
name: string;
parentId: string;
projectId: string;
updated: string;
updatedBy: UserDto;
}
Properties
created
created: string
created
id
id: string
name
name: string
parent
parent
project
project
updated
updated: string
updated
Generated using TypeDoc
Interface InfoDto
interface InfoDto {
authorizedOrganization: string;
createPermission: boolean;
deletePermission: boolean;
readPermission: boolean;
updatePermission: boolean;
version: string;
}
authorizedOrganization: string;
createPermission: boolean;
deletePermission: boolean;
readPermission: boolean;
updatePermission: boolean;
version: string;
}
Index
Properties
authorized
authorized
create
create
delete
delete
read
read
update
update
version
version: string
Generated using TypeDoc
Generated using TypeDoc
Interface MilestoneMetadataDto
interface MilestoneMetadataDto {
created: string;
createdBy: UserDto;
fileId: string;
id: string;
name: string;
updated: string;
updatedBy: UserDto;
}
created: string;
createdBy: UserDto;
fileId: string;
id: string;
name: string;
updated: string;
updatedBy: UserDto;
}
Properties
created
created: string
created
file
file
id
id: string
name
name: string
updated
updated: string
updated
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Interface PubSearchResultDtoProjectCollaboratorDto
interface PubSearchResultDtoProjectCollaboratorDto {
items: ProjectCollaboratorDto[];
total: number;
}
items: ProjectCollaboratorDto[];
total: number;
}
Properties
items
total
total: number
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Interface UpdateFileDto
interface UpdateFileDto {
content: string;
folderId: string;
name: string;
projectId: string;
revision: number;
}
content: string;
folderId: string;
name: string;
projectId: string;
revision: number;
}
Properties
content
content: string
folder
folder
maxLength: 255, minLength: 1
-name
name: string
maxLength: 255, minLength: 1
-project
project
maxLength: 255, minLength: 1
-revision
revision: number
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Interface Query<T>
interface Query<T> {
filter?: Partial<T>;
searchAfter?: unknown[];
size?: number;
sort?: [{
field: keyof T;
order: "ASC" | "DESC";
}];
}
filter?: Partial<T>;
searchAfter?: unknown[];
size?: number;
sort?: [{
field: keyof T;
order: "ASC" | "DESC";
}];
}
Type Parameters
Index
Properties
Properties
Optional filter
Optional search
search
Optional size
size?: number
Optional sort
Type declaration
field: keyof T
order: "ASC" | "DESC"
Generated using TypeDoc
Generated using TypeDoc
Interface CloudEventV1<T>
The object interface for CloudEvents 1.0.
-interface CloudEventV1<T> {
data?: T;
data_base64?: string;
datacontenttype?: string;
dataschema?: string;
id: string;
source: string;
specversion: string;
subject?: string;
time?: string;
type: string;
}
data?: T;
data_base64?: string;
datacontenttype?: string;
dataschema?: string;
id: string;
source: string;
specversion: string;
subject?: string;
time?: string;
type: string;
}
Type Parameters
Hierarchy (view full)
- CloudEventV1Attributes<T>
- CloudEventV1
Index
Properties
data?
-data_
Properties
Optional data
[OPTIONAL] The event payload. This specification does not place any restriction -on the type of this information. It is encoded into a media format which is -specified by the datacontenttype attribute (e.g. application/json), and adheres -to the dataschema format when those respective attributes are present.
-Optional data_
data_
[OPTIONAL] The event payload encoded as base64 data. This is used when the -data is in binary form.
-Optional datacontenttype
datacontenttype?: string
[OPTIONAL] Content type of data value. This attribute enables data to
-carry any type of content, whereby format and encoding might differ from that
-of the chosen event format. For example, an event rendered using the
-JSON envelope format might carry an XML payload
-in data, and the consumer is informed by this attribute being set to
-"application/xml". The rules for how data content is rendered for different
-datacontenttype values are defined in the event format specifications; for
-example, the JSON event format defines the relationship in
-section 3.1.
Optional dataschema
dataschema?: string
[OPTIONAL] Identifies the schema that data adheres to. Incompatible
-changes to the schema SHOULD be reflected by a different URI. See
-Versioning of Attributes in the Primer
-for more information.
-If present, MUST be a non-empty URI.
id
id: string
[REQUIRED] Identifies the event. Producers MUST ensure that source + id
-is unique for each distinct event. If a duplicate event is re-sent (e.g. due
-to a network error) it MAY have the same id. Consumers MAY assume that
-Events with identical source and id are duplicates.
Required
Non-empty string. Unique within producer.
-Example
An event counter maintained by the producer
-Example
A UUID
-source
source: string
[REQUIRED] Identifies the context in which an event happened. Often this
-will include information such as the type of the event source, the
-organization publishing the event or the process that produced the event. The
-exact syntax and semantics behind the data encoded in the URI is defined by
-the event producer.
-Producers MUST ensure that source + id is unique for each distinct event.
-An application MAY assign a unique source to each distinct producer, which
-makes it easy to produce unique IDs since no other producer will have the same
-source. The application MAY use UUIDs, URNs, DNS authorities or an
-application-specific scheme to create unique source identifiers.
-A source MAY include more than one producer. In that case the producers MUST
-collaborate to ensure that source + id is unique for each distinct event.
Required
Non-empty URI-reference
-specversion
specversion: string
[REQUIRED] The version of the CloudEvents specification which the event
-uses. This enables the interpretation of the context. Compliant event
-producers MUST use a value of 1.0 when referring to this version of the
-specification.
Required
MUST be a non-empty string.
-Optional subject
subject?: string
[OPTIONAL] This describes the subject of the event in the context of the
-event producer (identified by source). In publish-subscribe scenarios, a
-subscriber will typically subscribe to events emitted by a source, but the
-source identifier alone might not be sufficient as a qualifier for any
-specific event if the source context has internal sub-structure.
Identifying the subject of the event in context metadata (opposed to only in
-the data payload) is particularly helpful in generic subscription filtering
-scenarios where middleware is unable to interpret the data content. In the
-above example, the subscriber might only be interested in blobs with names
-ending with '.jpg' or '.jpeg' and the subject attribute allows for
-constructing a simple and efficient string-suffix filter for that subset of
-events.
If present, MUST be a non-empty string.
-Example
"https://example.com/storage/tenant/container"
-Example
"mynewfile.jpg"
-Optional time
time?: string
[OPTIONAL] Timestamp of when the occurrence happened. If the time of the
-occurrence cannot be determined then this attribute MAY be set to some other
-time (such as the current time) by the CloudEvents producer, however all
-producers for the same source MUST be consistent in this respect. In other
-words, either they all use the actual time of the occurrence or they all use
-the same algorithm to determine the value used.
Example
"2020-08-08T14:48:09.769Z"
-type
type: string
[REQUIRED] This attribute contains a value describing the type of event
-related to the originating occurrence. Often this attribute is used for
-routing, observability, policy enforcement, etc. The format of this is
-producer defined and might include information such as the version of the
-type - see
-Versioning of Attributes in the Primer
-for more information.
Required
MUST be a non-empty string
-Should
SHOULD be prefixed with a reverse-DNS name. The prefixed domain dictates the - organization which defines the semantics of this event type.
-Example
com.github.pull.create
-Example
com.example.object.delete.v2
-Generated using TypeDoc
Interface CloudEventV1Attributes<T>
interface CloudEventV1Attributes<T> {
data?: T;
data_base64?: string;
datacontenttype?: string;
dataschema?: string;
source: string;
subject?: string;
time?: string;
type: string;
}
data?: T;
data_base64?: string;
datacontenttype?: string;
dataschema?: string;
source: string;
subject?: string;
time?: string;
type: string;
}
Type Parameters
Hierarchy (view full)
- CloudEventV1OptionalAttributes<T>
- CloudEventV1Attributes
Index
Properties
Properties
Optional data
[OPTIONAL] The event payload. This specification does not place any restriction -on the type of this information. It is encoded into a media format which is -specified by the datacontenttype attribute (e.g. application/json), and adheres -to the dataschema format when those respective attributes are present.
-Optional data_
data_
[OPTIONAL] The event payload encoded as base64 data. This is used when the -data is in binary form.
-Optional datacontenttype
datacontenttype?: string
[OPTIONAL] Content type of data value. This attribute enables data to
-carry any type of content, whereby format and encoding might differ from that
-of the chosen event format. For example, an event rendered using the
-JSON envelope format might carry an XML payload
-in data, and the consumer is informed by this attribute being set to
-"application/xml". The rules for how data content is rendered for different
-datacontenttype values are defined in the event format specifications; for
-example, the JSON event format defines the relationship in
-section 3.1.
Optional dataschema
dataschema?: string
[OPTIONAL] Identifies the schema that data adheres to. Incompatible
-changes to the schema SHOULD be reflected by a different URI. See
-Versioning of Attributes in the Primer
-for more information.
-If present, MUST be a non-empty URI.
source
source: string
[REQUIRED] Identifies the context in which an event happened. Often this
-will include information such as the type of the event source, the
-organization publishing the event or the process that produced the event. The
-exact syntax and semantics behind the data encoded in the URI is defined by
-the event producer.
-Producers MUST ensure that source + id is unique for each distinct event.
-An application MAY assign a unique source to each distinct producer, which
-makes it easy to produce unique IDs since no other producer will have the same
-source. The application MAY use UUIDs, URNs, DNS authorities or an
-application-specific scheme to create unique source identifiers.
-A source MAY include more than one producer. In that case the producers MUST
-collaborate to ensure that source + id is unique for each distinct event.
Required
Non-empty URI-reference
-Optional subject
subject?: string
[OPTIONAL] This describes the subject of the event in the context of the
-event producer (identified by source). In publish-subscribe scenarios, a
-subscriber will typically subscribe to events emitted by a source, but the
-source identifier alone might not be sufficient as a qualifier for any
-specific event if the source context has internal sub-structure.
Identifying the subject of the event in context metadata (opposed to only in
-the data payload) is particularly helpful in generic subscription filtering
-scenarios where middleware is unable to interpret the data content. In the
-above example, the subscriber might only be interested in blobs with names
-ending with '.jpg' or '.jpeg' and the subject attribute allows for
-constructing a simple and efficient string-suffix filter for that subset of
-events.
If present, MUST be a non-empty string.
-Example
"https://example.com/storage/tenant/container"
-Example
"mynewfile.jpg"
-Optional time
time?: string
[OPTIONAL] Timestamp of when the occurrence happened. If the time of the
-occurrence cannot be determined then this attribute MAY be set to some other
-time (such as the current time) by the CloudEvents producer, however all
-producers for the same source MUST be consistent in this respect. In other
-words, either they all use the actual time of the occurrence or they all use
-the same algorithm to determine the value used.
Example
"2020-08-08T14:48:09.769Z"
-type
type: string
[REQUIRED] This attribute contains a value describing the type of event
-related to the originating occurrence. Often this attribute is used for
-routing, observability, policy enforcement, etc. The format of this is
-producer defined and might include information such as the version of the
-type - see
-Versioning of Attributes in the Primer
-for more information.
Required
MUST be a non-empty string
-Should
SHOULD be prefixed with a reverse-DNS name. The prefixed domain dictates the - organization which defines the semantics of this event type.
-Example
com.github.pull.create
-Example
com.example.object.delete.v2
-Generated using TypeDoc
Interface CloudEventV1OptionalAttributes<T>
interface CloudEventV1OptionalAttributes<T> {
data?: T;
data_base64?: string;
datacontenttype?: string;
dataschema?: string;
subject?: string;
time?: string;
[key: string]: unknown;
}
data?: T;
data_base64?: string;
datacontenttype?: string;
dataschema?: string;
subject?: string;
time?: string;
[key: string]: unknown;
}
Type Parameters
Hierarchy (view full)
- CloudEventV1OptionalAttributes
Indexable
[key: string]: unknown
[OPTIONAL] CloudEvents extension attributes.
- Index
Properties
Properties
Optional data
[OPTIONAL] The event payload. This specification does not place any restriction -on the type of this information. It is encoded into a media format which is -specified by the datacontenttype attribute (e.g. application/json), and adheres -to the dataschema format when those respective attributes are present.
-Optional data_
data_
[OPTIONAL] The event payload encoded as base64 data. This is used when the -data is in binary form.
-Optional datacontenttype
datacontenttype?: string
[OPTIONAL] Content type of data value. This attribute enables data to
-carry any type of content, whereby format and encoding might differ from that
-of the chosen event format. For example, an event rendered using the
-JSON envelope format might carry an XML payload
-in data, and the consumer is informed by this attribute being set to
-"application/xml". The rules for how data content is rendered for different
-datacontenttype values are defined in the event format specifications; for
-example, the JSON event format defines the relationship in
-section 3.1.
Optional dataschema
dataschema?: string
[OPTIONAL] Identifies the schema that data adheres to. Incompatible
-changes to the schema SHOULD be reflected by a different URI. See
-Versioning of Attributes in the Primer
-for more information.
-If present, MUST be a non-empty URI.
Optional subject
subject?: string
[OPTIONAL] This describes the subject of the event in the context of the
-event producer (identified by source). In publish-subscribe scenarios, a
-subscriber will typically subscribe to events emitted by a source, but the
-source identifier alone might not be sufficient as a qualifier for any
-specific event if the source context has internal sub-structure.
Identifying the subject of the event in context metadata (opposed to only in
-the data payload) is particularly helpful in generic subscription filtering
-scenarios where middleware is unable to interpret the data content. In the
-above example, the subscriber might only be interested in blobs with names
-ending with '.jpg' or '.jpeg' and the subject attribute allows for
-constructing a simple and efficient string-suffix filter for that subset of
-events.
If present, MUST be a non-empty string.
-Example
"https://example.com/storage/tenant/container"
-Example
"mynewfile.jpg"
-Optional time
time?: string
[OPTIONAL] Timestamp of when the occurrence happened. If the time of the
-occurrence cannot be determined then this attribute MAY be set to some other
-time (such as the current time) by the CloudEvents producer, however all
-producers for the same source MUST be consistent in this respect. In other
-words, either they all use the actual time of the occurrence or they all use
-the same algorithm to determine the value used.
Example
"2020-08-08T14:48:09.769Z"
-Generated using TypeDoc
Interface DashboardDefinition
interface DashboardDefinition {
availableFilters: unknown[];
collectionId: null | string;
exportEntityType: "dashboard";
id: string;
name: string;
reports: {
id: string;
}[];
sourceIndexVersion: number;
}
availableFilters: unknown[];
collectionId: null | string;
exportEntityType: "dashboard";
id: string;
name: string;
reports: {
id: string;
}[];
sourceIndexVersion: number;
}
Index
Properties
Properties
available
available
collection
collection
export
export
id
id: string
name
name: string
reports
reports: {
id: string;
}[]
id: string;
}[]
Type declaration
id: string
source
source
Generated using TypeDoc
Interface ReportData
interface ReportData {
businessKey: string;
duration: number;
endDate: string;
engineName: string;
processDefinitionId: string;
processDefinitionKey: string;
processInstanceId: string;
startDate: string;
tenantId: null;
variables: unknown;
}
businessKey: string;
duration: number;
endDate: string;
engineName: string;
processDefinitionId: string;
processDefinitionKey: string;
processInstanceId: string;
startDate: string;
tenantId: null;
variables: unknown;
}
Index
Properties
Properties
business
business
duration
duration: number
end
end
engine
engine
process
process
process
process
process
process
start
start
tenant
tenant
variables
variables: unknown
Generated using TypeDoc
Interface ReportDataExporter
Index
Properties
next
-
Properties
next
Type declaration
- (): Promise<ReportDataPage>
Returns Promise<ReportDataPage>
Generated using TypeDoc
Interface ReportDataPage
interface ReportDataPage {
data: ReportData[];
numberOfRecordsInResponse: number;
reportId: string;
searchRequestId: string;
totalNumberOfRecords: number;
}
data: ReportData[];
numberOfRecordsInResponse: number;
reportId: string;
searchRequestId: string;
totalNumberOfRecords: number;
}
Index
Properties
Properties
data
number
number
report
report
search
search
total
total
Generated using TypeDoc
Interface Variable
interface Variable {
id: string;
name: string;
processDefinitionKey: string;
processInstanceId: string;
type: VariableType;
value: string;
}
id: string;
name: string;
processDefinitionKey: string;
processInstanceId: string;
type: VariableType;
value: string;
}
Index
Properties
Properties
id
id: string
name
name: string
process
process
process
process
type
value
value: string
Generated using TypeDoc
Interface VariableLabel
interface VariableLabel {
variableLabel: string;
variableName: string;
variableType: VariableType;
}
variableLabel: string;
variableName: string;
variableType: VariableType;
}
Index
Properties
Properties
variable
variable
variable
variable
variable
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Interface DraftSearchVariableValue
interface DraftSearchVariableValue {
isValueTruncated: boolean;
previewValue: string;
value: string;
}
isValueTruncated: boolean;
previewValue: string;
value: string;
}
Index
Properties
Properties
is
is
preview
preview
value
value: string
Generated using TypeDoc
Generated using TypeDoc
Interface TaskSearchAfterOrEqualRequest
interface TaskSearchAfterOrEqualRequest {
assigned?: boolean;
assignee?: string;
assignees?: string[];
candidateGroup?: string;
candidateGroups?: string[];
candidateUser?: string;
candidateUsers?: string[];
dueDate?: DateFilter;
followUpDate?: DateFilter;
implementation?: "JOB_WORKER" | "ZEEBE_USER_TASK";
includeVariables?: IncludeVariable[];
pageSize?: number;
processDefinitionKey?: string;
processInstanceKey?: string;
searchAfterOrEqual: string[];
sort?: TaskOrderBy[];
state?: TaskState;
taskDefinitionId?: string;
taskVariables?: TaskByVariables[];
tenantIds?: string[];
}
assigned?: boolean;
assignee?: string;
assignees?: string[];
candidateGroup?: string;
candidateGroups?: string[];
candidateUser?: string;
candidateUsers?: string[];
dueDate?: DateFilter;
followUpDate?: DateFilter;
implementation?: "JOB_WORKER" | "ZEEBE_USER_TASK";
includeVariables?: IncludeVariable[];
pageSize?: number;
processDefinitionKey?: string;
processInstanceKey?: string;
searchAfterOrEqual: string[];
sort?: TaskOrderBy[];
state?: TaskState;
taskDefinitionId?: string;
taskVariables?: TaskByVariables[];
tenantIds?: string[];
}
Hierarchy
- Partial<TaskSearchRequestBase>
- TaskSearchAfterOrEqualRequest
Index
Properties
assigned?
-assignee?
-assignees?
-candidate
Properties
Optional assigned
assigned?: boolean
Optional assignee
assignee?: string
Optional assignees
assignees?: string[]
Optional candidate
candidate
Optional candidate
candidate
Optional candidate
candidate
Optional candidate
candidate
Optional due
Optional follow
Optional implementation
implementation?: "JOB_WORKER" | "ZEEBE_USER_TASK"
Optional include
An array used to specify a list of variable names that should be included in the response when querying tasks. -This field allows users to selectively retrieve specific variables associated with the tasks returned in the search results.
-Optional page
page
Optional process
process
Optional process
process
search
search
Used to return a paginated result. Array of values that should be copied from sortValues of one of the tasks from the current search results page. -It enables the API to return a page of tasks that directly follow or are equal to the task identified by the provided values, with respect to the sorting order.
-Optional sort
Optional state
Optional task
task
Optional task
An array of filter clauses specifying the variables to filter for. -If defined, the query returns only tasks to which all clauses apply. -However, it's important to note that this filtering mechanism is -designed to work exclusively with truncated variables. This means -variables of a larger size are not compatible with this filter, and -attempts to use them may result in inaccurate or incomplete query results.
-Optional tenant
tenant
Generated using TypeDoc
Interface TaskSearchAfterRequest
interface TaskSearchAfterRequest {
assigned?: boolean;
assignee?: string;
assignees?: string[];
candidateGroup?: string;
candidateGroups?: string[];
candidateUser?: string;
candidateUsers?: string[];
dueDate?: DateFilter;
followUpDate?: DateFilter;
implementation?: "JOB_WORKER" | "ZEEBE_USER_TASK";
includeVariables?: IncludeVariable[];
pageSize?: number;
processDefinitionKey?: string;
processInstanceKey?: string;
searchAfter: string[];
sort?: TaskOrderBy[];
state?: TaskState;
taskDefinitionId?: string;
taskVariables?: TaskByVariables[];
tenantIds?: string[];
}
assigned?: boolean;
assignee?: string;
assignees?: string[];
candidateGroup?: string;
candidateGroups?: string[];
candidateUser?: string;
candidateUsers?: string[];
dueDate?: DateFilter;
followUpDate?: DateFilter;
implementation?: "JOB_WORKER" | "ZEEBE_USER_TASK";
includeVariables?: IncludeVariable[];
pageSize?: number;
processDefinitionKey?: string;
processInstanceKey?: string;
searchAfter: string[];
sort?: TaskOrderBy[];
state?: TaskState;
taskDefinitionId?: string;
taskVariables?: TaskByVariables[];
tenantIds?: string[];
}
Hierarchy
- Partial<TaskSearchRequestBase>
- TaskSearchAfterRequest
Index
Properties
Properties
Optional assigned
assigned?: boolean
Optional assignee
assignee?: string
Optional assignees
assignees?: string[]
Optional candidate
candidate
Optional candidate
candidate
Optional candidate
candidate
Optional candidate
candidate
Optional due
Optional follow
Optional implementation
implementation?: "JOB_WORKER" | "ZEEBE_USER_TASK"
Optional include
An array used to specify a list of variable names that should be included in the response when querying tasks. -This field allows users to selectively retrieve specific variables associated with the tasks returned in the search results.
-Optional page
page
Optional process
process
Optional process
process
search
search
Used to return a paginated result. Array of values that should be copied from sortValues of one of the tasks from the current search results page. -It enables the API to return a page of tasks that directly follow the task identified by the provided values, with respect to the sorting order.
-Optional sort
Optional state
Optional task
task
Optional task
An array of filter clauses specifying the variables to filter for. -If defined, the query returns only tasks to which all clauses apply. -However, it's important to note that this filtering mechanism is -designed to work exclusively with truncated variables. This means -variables of a larger size are not compatible with this filter, and -attempts to use them may result in inaccurate or incomplete query results.
-Optional tenant
tenant
Generated using TypeDoc
Interface TaskSearchBeforeOrEqualRequest
interface TaskSearchBeforeOrEqualRequest {
assigned?: boolean;
assignee?: string;
assignees?: string[];
candidateGroup?: string;
candidateGroups?: string[];
candidateUser?: string;
candidateUsers?: string[];
dueDate?: DateFilter;
followUpDate?: DateFilter;
implementation?: "JOB_WORKER" | "ZEEBE_USER_TASK";
includeVariables?: IncludeVariable[];
pageSize?: number;
processDefinitionKey?: string;
processInstanceKey?: string;
searchBeforeOrEqual: string[];
sort?: TaskOrderBy[];
state?: TaskState;
taskDefinitionId?: string;
taskVariables?: TaskByVariables[];
tenantIds?: string[];
}
assigned?: boolean;
assignee?: string;
assignees?: string[];
candidateGroup?: string;
candidateGroups?: string[];
candidateUser?: string;
candidateUsers?: string[];
dueDate?: DateFilter;
followUpDate?: DateFilter;
implementation?: "JOB_WORKER" | "ZEEBE_USER_TASK";
includeVariables?: IncludeVariable[];
pageSize?: number;
processDefinitionKey?: string;
processInstanceKey?: string;
searchBeforeOrEqual: string[];
sort?: TaskOrderBy[];
state?: TaskState;
taskDefinitionId?: string;
taskVariables?: TaskByVariables[];
tenantIds?: string[];
}
Hierarchy
- Partial<TaskSearchRequestBase>
- TaskSearchBeforeOrEqualRequest
Index
Properties
assigned?
-assignee?
-assignees?
-candidate
Properties
Optional assigned
assigned?: boolean
Optional assignee
assignee?: string
Optional assignees
assignees?: string[]
Optional candidate
candidate
Optional candidate
candidate
Optional candidate
candidate
Optional candidate
candidate
Optional due
Optional follow
Optional implementation
implementation?: "JOB_WORKER" | "ZEEBE_USER_TASK"
Optional include
An array used to specify a list of variable names that should be included in the response when querying tasks. -This field allows users to selectively retrieve specific variables associated with the tasks returned in the search results.
-Optional page
page
Optional process
process
Optional process
process
search
search
Used to return a paginated result. Array of values that should be copied from sortValues of one of the tasks from the current search results page. -It enables the API to return a page of tasks that directly precede or are equal to the task identified by the provided values, with respect to the sorting order.
-Optional sort
Optional state
Optional task
task
Optional task
An array of filter clauses specifying the variables to filter for. -If defined, the query returns only tasks to which all clauses apply. -However, it's important to note that this filtering mechanism is -designed to work exclusively with truncated variables. This means -variables of a larger size are not compatible with this filter, and -attempts to use them may result in inaccurate or incomplete query results.
-Optional tenant
tenant
Generated using TypeDoc
Interface TaskSearchBeforeRequest
interface TaskSearchBeforeRequest {
assigned?: boolean;
assignee?: string;
assignees?: string[];
candidateGroup?: string;
candidateGroups?: string[];
candidateUser?: string;
candidateUsers?: string[];
dueDate?: DateFilter;
followUpDate?: DateFilter;
implementation?: "JOB_WORKER" | "ZEEBE_USER_TASK";
includeVariables?: IncludeVariable[];
pageSize?: number;
processDefinitionKey?: string;
processInstanceKey?: string;
searchBefore: string[];
sort?: TaskOrderBy[];
state?: TaskState;
taskDefinitionId?: string;
taskVariables?: TaskByVariables[];
tenantIds?: string[];
}
assigned?: boolean;
assignee?: string;
assignees?: string[];
candidateGroup?: string;
candidateGroups?: string[];
candidateUser?: string;
candidateUsers?: string[];
dueDate?: DateFilter;
followUpDate?: DateFilter;
implementation?: "JOB_WORKER" | "ZEEBE_USER_TASK";
includeVariables?: IncludeVariable[];
pageSize?: number;
processDefinitionKey?: string;
processInstanceKey?: string;
searchBefore: string[];
sort?: TaskOrderBy[];
state?: TaskState;
taskDefinitionId?: string;
taskVariables?: TaskByVariables[];
tenantIds?: string[];
}
Hierarchy
- Partial<TaskSearchRequestBase>
- TaskSearchBeforeRequest
Index
Properties
Properties
Optional assigned
assigned?: boolean
Optional assignee
assignee?: string
Optional assignees
assignees?: string[]
Optional candidate
candidate
Optional candidate
candidate
Optional candidate
candidate
Optional candidate
candidate
Optional due
Optional follow
Optional implementation
implementation?: "JOB_WORKER" | "ZEEBE_USER_TASK"
Optional include
An array used to specify a list of variable names that should be included in the response when querying tasks. -This field allows users to selectively retrieve specific variables associated with the tasks returned in the search results.
-Optional page
page
Optional process
process
Optional process
process
search
search
Used to return a paginated result. Array of values that should be copied from sortValues of one of the tasks from the current search results page. -It enables the API to return a page of tasks that directly precede the task identified by the provided values, with respect to the sorting order.
-Optional sort
Optional state
Optional task
task
Optional task
An array of filter clauses specifying the variables to filter for. -If defined, the query returns only tasks to which all clauses apply. -However, it's important to note that this filtering mechanism is -designed to work exclusively with truncated variables. This means -variables of a larger size are not compatible with this filter, and -attempts to use them may result in inaccurate or incomplete query results.
-Optional tenant
tenant
Generated using TypeDoc
Interface TaskSearchRequestBase
interface TaskSearchRequestBase {
assigned: boolean;
assignee: string;
assignees: string[];
candidateGroup: string;
candidateGroups: string[];
candidateUser: string;
candidateUsers: string[];
dueDate: DateFilter;
followUpDate: DateFilter;
implementation: "JOB_WORKER" | "ZEEBE_USER_TASK";
includeVariables: IncludeVariable[];
pageSize: number;
processDefinitionKey: string;
processInstanceKey: string;
sort: TaskOrderBy[];
state: TaskState;
taskDefinitionId: string;
taskVariables: TaskByVariables[];
tenantIds: string[];
}
assigned: boolean;
assignee: string;
assignees: string[];
candidateGroup: string;
candidateGroups: string[];
candidateUser: string;
candidateUsers: string[];
dueDate: DateFilter;
followUpDate: DateFilter;
implementation: "JOB_WORKER" | "ZEEBE_USER_TASK";
includeVariables: IncludeVariable[];
pageSize: number;
processDefinitionKey: string;
processInstanceKey: string;
sort: TaskOrderBy[];
state: TaskState;
taskDefinitionId: string;
taskVariables: TaskByVariables[];
tenantIds: string[];
}
Properties
assigned
assigned: boolean
assignee
assignee: string
assignees
assignees: string[]
candidate
candidate
candidate
candidate
candidate
candidate
candidate
candidate
due
follow
implementation
implementation: "JOB_WORKER" | "ZEEBE_USER_TASK"
include
An array used to specify a list of variable names that should be included in the response when querying tasks. -This field allows users to selectively retrieve specific variables associated with the tasks returned in the search results.
-page
page
process
process
process
process
sort
state
task
task
task
An array of filter clauses specifying the variables to filter for. -If defined, the query returns only tasks to which all clauses apply. -However, it's important to note that this filtering mechanism is -designed to work exclusively with truncated variables. This means -variables of a larger size are not compatible with this filter, and -attempts to use them may result in inaccurate or incomplete query results.
-tenant
tenant
Generated using TypeDoc
Interface User
interface User {
displayName: string;
permissions: string[];
roles: string[];
salesPlanType: string;
userId: string;
}
displayName: string;
permissions: string[];
roles: string[];
salesPlanType: string;
userId: string;
}
Index
Properties
Properties
display
display
permissions
permissions: string[]
roles
roles: string[]
sales
sales
user
user
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Interface VariableSearchResponse
interface VariableSearchResponse {
draft: DraftSearchVariableValue;
id: string;
name: string;
previewValue: string;
value: string;
}
draft: DraftSearchVariableValue;
id: string;
name: string;
previewValue: string;
value: string;
}
Hierarchy (view full)
- VariableSearchResponseWithoutDraft
- VariableSearchResponse
Index
Properties
Properties
draft
id
id: string
name
name: string
preview
preview
value
value: string
Generated using TypeDoc
Interface VariableSearchResponseWithoutDraft
interface VariableSearchResponseWithoutDraft {
id: string;
name: string;
previewValue: string;
value: string;
}
id: string;
name: string;
previewValue: string;
value: string;
}
Hierarchy (view full)
- VariableSearchResponseWithoutDraft
Index
Properties
Properties
id
id: string
name
name: string
preview
preview
value
value: string
Generated using TypeDoc
Interface Characteristics
Index
Properties
_tag
-startup
Properties
_tag
startup
startup
Generated using TypeDoc
Interface Emitter<T>
interface Emitter<T> {
emit<K>(eventName, params?): void;
off<K>(eventName, fn): void;
on<K>(eventName, fn): void;
}
emit<K>(eventName, params?): void;
off<K>(eventName, fn): void;
on<K>(eventName, fn): void;
}
Type Parameters
- T extends EventMap
Implemented by
Methods
emit
- emit<K>(eventName, params?): void
Type Parameters
Returns void
off
- off<K>(eventName, fn): void
Type Parameters
Parameters
- eventName: K
- fn: EventReceiver
Returns void
on
- on<K>(eventName, fn): void
Type Parameters
Parameters
- eventName: K
- fn: EventReceiver
Returns void
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Interface ZBWorkerConstructorConfig<WorkerInputVariables, CustomHeaderShape, WorkerOutputVariables>
interface ZBWorkerConstructorConfig<WorkerInputVariables, CustomHeaderShape, WorkerOutputVariables> {
customHeadersDto?: (new (...args) => Readonly<CustomHeaderShape>);
grpcClient: ZBGrpc;
id: null | string;
idColor: Chalk;
inputVariableDto?: (new (...args) => Readonly<WorkerInputVariables>);
log: StatefulLogInterceptor;
options: ZBWorkerOptions<WorkerInputVariables> & ZBClientOptions;
taskHandler: ZBWorkerTaskHandler<WorkerInputVariables, CustomHeaderShape, WorkerOutputVariables>;
taskType: string;
zbClient: ZeebeGrpcClient;
}
customHeadersDto?: (new (...args) => Readonly<CustomHeaderShape>);
grpcClient: ZBGrpc;
id: null | string;
idColor: Chalk;
inputVariableDto?: (new (...args) => Readonly<WorkerInputVariables>);
log: StatefulLogInterceptor;
options: ZBWorkerOptions<WorkerInputVariables> & ZBClientOptions;
taskHandler: ZBWorkerTaskHandler<WorkerInputVariables, CustomHeaderShape, WorkerOutputVariables>;
taskType: string;
zbClient: ZeebeGrpcClient;
}
Type Parameters
Index
Properties
Properties
Optional custom
Type declaration
- new (...args): Readonly<CustomHeaderShape>
Parameters
Rest...args: any[]
Returns Readonly<CustomHeaderShape>
grpc
id
id: null | string
id
id
Optional input
Type declaration
- new (...args): Readonly<WorkerInputVariables>
Parameters
Rest...args: any[]
Returns Readonly<WorkerInputVariables>
log
options
task
task
task
zb
Generated using TypeDoc
Interface ActivateInstruction
interface ActivateInstruction {
ancestorElementInstanceKey: string;
elementId: string;
variableInstructions: VariableInstruction[];
}
ancestorElementInstanceKey: string;
elementId: string;
variableInstructions: VariableInstruction[];
}
Index
Properties
Properties
ancestor
ancestor
the key of the ancestor scope the element instance should be created in; -set to -1 to create the new element instance within an existing element -instance of the flow scope
-element
element
the id of the element that should be activated
-variable
instructions describing which variables should be created
-Generated using TypeDoc
Interface ActivateJobsRequest
Request object to send the broker to request jobs for the worker.
-interface ActivateJobsRequest {
fetchVariable?: string[];
maxJobsToActivate: number;
requestTimeout: MaybeTimeDuration;
tenantIds?: string[];
timeout: MaybeTimeDuration;
type: string;
worker: string;
}
fetchVariable?: string[];
maxJobsToActivate: number;
requestTimeout: MaybeTimeDuration;
tenantIds?: string[];
timeout: MaybeTimeDuration;
type: string;
worker: string;
}
Index
Properties
Properties
Optional fetch
fetch
A list of variables to fetch as the job variables; if empty, all visible variables at -the time of activation for the scope of the job will be returned
-max
max
The maximum jobs to activate by this request
-request
request
The request will be completed when atleast one job is activated or after the requestTimeout. -if the requestTimeout = 0, the request will be completed after a default configured timeout in the broker. -To immediately complete the request when no job is activated set the requestTimeout to a negative value
-Optional tenant
tenant
a list of IDs of tenants for which to activate jobs
-timeout
timeout: MaybeTimeDuration
The duration the broker allows for jobs activated by this call to complete -before timing them out releasing them for retry on the broker. -The broker checks time outs every 30 seconds, so the broker timeout is guaranteed in at-most timeout + 29s -be guaranteed.
-type
type: string
The job type, as defined in the BPMN process (e.g. <zeebe:taskDefinition -type="payment-service" />)
-worker
worker: string
The name of the worker activating the jobs, mostly used for logging purposes
-Generated using TypeDoc
Generated using TypeDoc
Interface ActivatedJob
interface ActivatedJob {
bpmnProcessId: string;
customHeaders: string;
deadline: string;
elementId: string;
elementInstanceKey: string;
key: string;
processDefinitionKey: string;
processDefinitionVersion: number;
processInstanceKey: string;
retries: number;
tenantId: string;
type: string;
variables: string;
worker: string;
}
bpmnProcessId: string;
customHeaders: string;
deadline: string;
elementId: string;
elementInstanceKey: string;
key: string;
processDefinitionKey: string;
processDefinitionVersion: number;
processInstanceKey: string;
retries: number;
tenantId: string;
type: string;
variables: string;
worker: string;
}
Index
Properties
Readonly bpmn
bpmn
The bpmn process ID of the job process definition
-Readonly custom
custom
A set of custom headers defined during modelling
-Readonly deadline
deadline: string
When the job will timeout on the broker if it is not completed by this worker. -In epoch milliseconds
-Readonly element
element
The associated task element ID
-Readonly element
element
The unique key identifying the associated task, unique within the scope of the -process instance
-Readonly key
key: string
The key, a unique identifier for the job
-Readonly process
process
The key of the job process definition
-Readonly process
process
The version of the job process definition
-Readonly process
process
The job's process instance key
-Readonly retries
retries: number
Readonly tenant
tenant
the id of the tenant that owns the job
-Readonly type
type: string
The job type, as defined in the BPMN process (e.g. <zeebe:taskDefinition -type="payment-service" />)
-Readonly variables
variables: string
All visible variables in the task scope, computed at activation time, constrained by any -fetchVariables value in the ActivateJobRequest.
-Readonly worker
worker: string
The name of the worker that activated this job
-Generated using TypeDoc
Generated using TypeDoc
Interface BroadcastSignalRequest
Index
Properties
Properties
signal
signal
The name of the signal
-Optional tenant
tenant
the id of the tenant that owns the signal.
-variables
variables: string
the signal variables as a JSON document; to be valid, the root of the document must be an -object, e.g. { "a": "foo" }. [ "foo" ] would not be valid.
-Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Interface CamundaCloudConfig
interface CamundaCloudConfig {
cacheDir?: string;
cacheOnDisk?: boolean;
clientId: string;
clientSecret: string;
clusterId: string;
clusterRegion?: string;
}
cacheDir?: string;
cacheOnDisk?: boolean;
clientId: string;
clientSecret: string;
clusterId: string;
clusterRegion?: string;
}
Index
Properties
Properties
Optional cache
cache
Optional cache
cache
client
client
Just the UUID of the cluster
-client
client
cluster
cluster
Optional cluster
cluster
Defaults to bru-2
Generated using TypeDoc
Generated using TypeDoc
Interface CreateProcessBaseRequest<V>
interface CreateProcessBaseRequest<V> {
bpmnProcessId: string;
tenantId?: string;
variables: V;
version?: number;
}
bpmnProcessId: string;
tenantId?: string;
variables: V;
version?: number;
}
Type Parameters
- V extends JSONDoc
Hierarchy (view full)
- CreateProcessBaseRequest
Index
Properties
Properties
bpmn
bpmn
the BPMN process ID of the process definition
-Optional tenant
tenant
The tenantId for a multi-tenant enabled cluster.
-variables
JSON document that will instantiate the variables for the root variable scope of the -process instance.
-Optional version
version?: number
the version of the process; if not specified it will use the latest version
-Generated using TypeDoc
Interface CreateProcessInstanceBaseRequest
interface CreateProcessInstanceBaseRequest {
bpmnProcessId: string;
tenantId?: string;
variables: string;
version?: number;
}
bpmnProcessId: string;
tenantId?: string;
variables: string;
version?: number;
}
Hierarchy (view full)
- CreateProcessInstanceBaseRequest
Index
Properties
Properties
bpmn
bpmn
the BPMN process ID of the process definition
-Optional tenant
tenant
the tenant id of the process definition
-variables
variables: string
JSON document that will instantiate the variables for the root variable scope of the -process instance.
-Optional version
version?: number
the version of the process; if not specified it will use the latest version
-Generated using TypeDoc
Interface CreateProcessInstanceReq<V>
interface CreateProcessInstanceReq<V> {
bpmnProcessId: string;
startInstructions?: ProcessInstanceCreationStartInstruction[];
tenantId?: string;
variables: V;
version?: number;
}
bpmnProcessId: string;
startInstructions?: ProcessInstanceCreationStartInstruction[];
tenantId?: string;
variables: V;
version?: number;
}
Type Parameters
- V extends JSONDoc
Hierarchy (view full)
- CreateProcessBaseRequest<V>
- CreateProcessInstanceReq
Index
Properties
Properties
bpmn
bpmn
the BPMN process ID of the process definition
-Optional start
List of start instructions. If empty (default) the process instance -will start at the start event. If non-empty the process instance will apply start -instructions after it has been created
-Optional tenant
tenant
The tenantId for a multi-tenant enabled cluster.
-variables
JSON document that will instantiate the variables for the root variable scope of the -process instance.
-Optional version
version?: number
the version of the process; if not specified it will use the latest version
-Generated using TypeDoc
Interface CreateProcessInstanceRequest
interface CreateProcessInstanceRequest {
bpmnProcessId: string;
startInstructions: ProcessInstanceCreationStartInstruction[];
tenantId?: string;
variables: string;
version?: number;
}
bpmnProcessId: string;
startInstructions: ProcessInstanceCreationStartInstruction[];
tenantId?: string;
variables: string;
version?: number;
}
Hierarchy (view full)
- CreateProcessInstanceBaseRequest
- CreateProcessInstanceRequest
Index
Properties
Properties
bpmn
bpmn
the BPMN process ID of the process definition
-start
List of start instructions. If empty (default) the process instance -will start at the start event. If non-empty the process instance will apply start -instructions after it has been created
-Optional tenant
tenant
the tenant id of the process definition
-variables
variables: string
JSON document that will instantiate the variables for the root variable scope of the -process instance.
-Optional version
version?: number
the version of the process; if not specified it will use the latest version
-Generated using TypeDoc
Interface CreateProcessInstanceResponse
interface CreateProcessInstanceResponse {
bpmnProcessId: string;
processDefinitionKey: string;
processInstanceKey: string;
tenantId: string;
version: number;
}
bpmnProcessId: string;
processDefinitionKey: string;
processInstanceKey: string;
tenantId: string;
version: number;
}
Index
Properties
Properties
Readonly bpmn
bpmn
The BPMN process ID of the process definition
-Readonly process
process
The unique key identifying the process definition (e.g. returned from a process -in the DeployResourceResponse message)
-Readonly process
process
Stringified JSON document that will instantiate the variables for the root variable scope of the
-process instance; it must be a JSON object, as variables will be mapped in a
-key-value fashion. e.g. { "a": 1, "b": 2 } will create two variables, named "a" and
-"b" respectively, with their associated values. [{ "a": 1, "b": 2 }] would not be a
valid argument, as the root of the JSON document is an array and not an object.
Readonly tenant
tenant
the tenant identifier of the created process instance
-Readonly version
version: number
The version of the process; set to -1 to use the latest version
-Generated using TypeDoc
Interface CreateProcessInstanceWithResultReq<T>
interface CreateProcessInstanceWithResultReq<T> {
bpmnProcessId: string;
fetchVariables?: string[];
requestTimeout?: number;
tenantId?: string;
variables: T;
version?: number;
}
bpmnProcessId: string;
fetchVariables?: string[];
requestTimeout?: number;
tenantId?: string;
variables: T;
version?: number;
}
Type Parameters
- T extends JSONDoc
Hierarchy (view full)
- CreateProcessBaseRequest<T>
- CreateProcessInstanceWithResultReq
Index
Properties
Properties
bpmn
bpmn
the BPMN process ID of the process definition
-Optional fetch
fetch
list of names of variables to be included in CreateProcessInstanceWithResultResponse.variables.
-If empty, all visible variables in the root scope will be returned.
Optional request
request
timeout in milliseconds. the request will be closed if the process is not completed before the requestTimeout. -if requestTimeout = 0, uses the generic requestTimeout configured in the gateway.
-Optional tenant
tenant
The tenantId for a multi-tenant enabled cluster.
-variables
JSON document that will instantiate the variables for the root variable scope of the -process instance.
-Optional version
version?: number
the version of the process; if not specified it will use the latest version
-Generated using TypeDoc
Interface CreateProcessInstanceWithResultRequest
interface CreateProcessInstanceWithResultRequest {
fetchVariables?: string[];
request: CreateProcessInstanceBaseRequest;
requestTimeout: number;
}
fetchVariables?: string[];
request: CreateProcessInstanceBaseRequest;
requestTimeout: number;
}
Index
Properties
Properties
Optional fetch
fetch
list of names of variables to be included in CreateProcessInstanceWithResultResponse.variables.
-If empty, all visible variables in the root scope will be returned.
request
request
request
timeout in milliseconds. the request will be closed if the process is not completed before the requestTimeout. -if requestTimeout = 0, uses the generic requestTimeout configured in the gateway.
-Generated using TypeDoc
Interface CreateProcessInstanceWithResultResponse<Result>
interface CreateProcessInstanceWithResultResponse<Result> {
bpmnProcessId: string;
processDefinitionKey: string;
processInstanceKey: string;
tenantId: string;
variables: Result;
version: number;
}
bpmnProcessId: string;
processDefinitionKey: string;
processInstanceKey: string;
tenantId: string;
variables: Result;
version: number;
}
Type Parameters
Hierarchy (view full)
- CreateProcessInstanceWithResultResponseBase
- CreateProcessInstanceWithResultResponse
Index
Properties
Properties
Readonly bpmn
bpmn
the BPMN process ID of the process definition which was used to create the process -instance
-Readonly process
process
the key of the process definition which was used to create the process instance
-Readonly process
process
the unique identifier of the created process instance; to be used wherever a request -needs a process instance key (e.g. CancelProcessInstanceRequest)
-Readonly tenant
tenant
the tenant identifier of the process definition
-Readonly variables
consisting of all visible variables to the root scope
-Readonly version
version: number
the version of the process definition which was used to create the process instance
-Generated using TypeDoc
Interface CreateProcessInstanceWithResultResponseOnWire
interface CreateProcessInstanceWithResultResponseOnWire {
bpmnProcessId: string;
processDefinitionKey: string;
processInstanceKey: string;
tenantId: string;
variables: string;
version: number;
}
bpmnProcessId: string;
processDefinitionKey: string;
processInstanceKey: string;
tenantId: string;
variables: string;
version: number;
}
Hierarchy (view full)
- CreateProcessInstanceWithResultResponseBase
- CreateProcessInstanceWithResultResponseOnWire
Index
Properties
Properties
Readonly bpmn
bpmn
the BPMN process ID of the process definition which was used to create the process -instance
-Readonly process
process
the key of the process definition which was used to create the process instance
-Readonly process
process
the unique identifier of the created process instance; to be used wherever a request -needs a process instance key (e.g. CancelProcessInstanceRequest)
-Readonly tenant
tenant
the tenant identifier of the process definition
-Readonly variables
variables: string
consisting of all visible variables to the root scope
-Readonly version
version: number
the version of the process definition which was used to create the process instance
-Generated using TypeDoc
Generated using TypeDoc
Interface DecisionMetadata
interface DecisionMetadata {
decisionKey: number;
decisionRequirementsKey: number;
dmnDecisionId: string;
dmnDecisionName: string;
dmnDecisionRequirementsId: string;
tenantId: string;
version: number;
}
decisionKey: number;
decisionRequirementsKey: number;
dmnDecisionId: string;
dmnDecisionName: string;
dmnDecisionRequirementsId: string;
tenantId: string;
version: number;
}
Index
Properties
decision
decision
the assigned decision key, which acts as a unique identifier for this -decision
-decision
decision
the assigned key of the decision requirements graph that this decision is -part of
-dmn
dmn
the dmn decision ID, as parsed during deployment; together with the -versions forms a unique identifier for a specific decision
-dmn
dmn
the dmn name of the decision, as parsed during deployment
-dmn
dmn
the dmn ID of the decision requirements graph that this decision is part -of, as parsed during deployment
-tenant
tenant
the tenant id of the deployed decision
-version
version: number
the assigned decision version
-Generated using TypeDoc
Generated using TypeDoc
Interface DecisionRequirementsMetadata
interface DecisionRequirementsMetadata {
decisionRequirementsKey: number;
dmnDecisionRequirementsId: string;
dmnDecisionRequirementsName: string;
resourceName: string;
tenantId: string;
version: number;
}
decisionRequirementsKey: number;
dmnDecisionRequirementsId: string;
dmnDecisionRequirementsName: string;
resourceName: string;
tenantId: string;
version: number;
}
Index
Properties
decision
decision
the assigned decision requirements key, which acts as a unique identifier -for this decision requirements
-dmn
dmn
the dmn decision requirements ID, as parsed during deployment; together -with the versions forms a unique identifier for a specific decision
-dmn
dmn
the dmn name of the decision requirements, as parsed during deployment
-resource
resource
the resource name (see: Resource.name) from which this decision -requirements was parsed
-tenant
tenant
the tenant id of the deployed decision requirements
-version
version: number
the assigned decision requirements version
-Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Interface EvaluateDecisionResponse
interface EvaluateDecisionResponse {
decisionId: string;
decisionKey: string;
decisionName: string;
decisionOutput: string;
decisionRequirementsId: string;
decisionRequirementsKey: string;
decisionVersion: number;
evaluatedDecisions: EvaluatedDecision[];
failedDecisionId: string;
failureMessage: string;
tenantId?: string;
}
decisionId: string;
decisionKey: string;
decisionName: string;
decisionOutput: string;
decisionRequirementsId: string;
decisionRequirementsKey: string;
decisionVersion: number;
evaluatedDecisions: EvaluatedDecision[];
failedDecisionId: string;
failureMessage: string;
tenantId?: string;
}
Properties
decision
decision
the ID of the decision which was evaluated
-decision
decision
the unique key identifying the decision which was evaluated (e.g. returned -from a decision in the DeployResourceResponse message)
-decision
decision
the name of the decision which was evaluated
-decision
decision
JSON document that will instantiate the result of the decision which was -evaluated; it will be a JSON object, as the result output will be mapped -in a key-value fashion, e.g. { "a": 1 }.
-decision
decision
the ID of the decision requirements graph that the decision which was -evaluated is part of.
-decision
decision
the unique key identifying the decision requirements graph that the -decision which was evaluated is part of.
-decision
decision
the version of the decision which was evaluated
-evaluated
a list of decisions that were evaluated within the requested decision evaluation
-failed
failed
an optional string indicating the ID of the decision which -failed during evaluation
-failure
failure
an optional message describing why the decision which was evaluated failed
-Optional tenant
tenant
the tenant identifier of the decision
-Generated using TypeDoc
Interface EvaluatedDecision
interface EvaluatedDecision {
decisionId: string;
decisionKey: string;
decisionName: string;
decisionOutput: string;
decisionType: string;
decisionVersion: number;
evaluatedInputs: EvaluatedDecisionInput[];
matchedRules: MatchedDecisionRule[];
tenantId: string;
}
decisionId: string;
decisionKey: string;
decisionName: string;
decisionOutput: string;
decisionType: string;
decisionVersion: number;
evaluatedInputs: EvaluatedDecisionInput[];
matchedRules: MatchedDecisionRule[];
tenantId: string;
}
Index
Properties
Properties
decision
decision
the ID of the decision which was evaluated
-decision
decision
the unique key identifying the decision which was evaluated (e.g. returned -from a decision in the DeployResourceResponse message)
-decision
decision
the name of the decision which was evaluated
-decision
decision
JSON document that will instantiate the result of the decision which was -evaluated; it will be a JSON object, as the result output will be mapped -in a key-value fashion, e.g. { "a": 1 }.
-decision
decision
the type of the decision which was evaluated
-decision
decision
the version of the decision which was evaluated
-evaluated
the decision inputs that were evaluated within this decision evaluation
-matched
the decision rules that matched within this decision evaluation
-tenant
tenant
the tenant identifier of the evaluated decision
-Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Interface FailJobRequest
interface FailJobRequest {
errorMessage: string;
jobKey: string;
retries: number;
retryBackOff: number;
}
errorMessage: string;
jobKey: string;
retries: number;
retryBackOff: number;
}
Index
Properties
Properties
error
error
Readonly job
job
retries
retries: number
retry
retry
Generated using TypeDoc
Generated using TypeDoc
Interface FormMetadata
interface FormMetadata {
formId: string;
formKey: number;
resourceName: string;
tenantId: string;
version: number;
}
formId: string;
formKey: number;
resourceName: string;
tenantId: string;
version: number;
}
Index
Properties
Properties
Readonly form
form
the form ID, as parsed during deployment; together with the -versions forms a unique identifier for a specific form
-Readonly form
form
the assigned key, which acts as a unique identifier for this form
-Readonly resource
resource
the resource name
-Readonly tenant
tenant
the tenant id of the deployed form
-Readonly version
version: number
the assigned form version
-Generated using TypeDoc
Interface ICustomHeaders
interface ICustomHeaders {
[key: string]: string | number;
}
[key: string]: string | number;
}
Indexable
[key: string]: string | number
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Interface Job<Variables, CustomHeaderShape>
interface Job<Variables, CustomHeaderShape> {
bpmnProcessId: string;
customHeaders: Readonly<CustomHeaderShape>;
deadline: string;
elementId: string;
elementInstanceKey: string;
key: string;
processDefinitionVersion: number;
processInstanceKey: string;
retries: number;
type: string;
variables: Readonly<Variables>;
worker: string;
}
bpmnProcessId: string;
customHeaders: Readonly<CustomHeaderShape>;
deadline: string;
elementId: string;
elementInstanceKey: string;
key: string;
processDefinitionVersion: number;
processInstanceKey: string;
retries: number;
type: string;
variables: Readonly<Variables>;
worker: string;
}
Type Parameters
- Variables = IInputVariables
- CustomHeaderShape = ICustomHeaders
Hierarchy (view full)
- Job
Index
Properties
Properties
Readonly bpmn
bpmn
The bpmn process ID of the job process definition
-Readonly custom
A set of custom headers defined during modelling
-Readonly deadline
deadline: string
Readonly element
element
The associated task element ID
-Readonly element
element
The unique key identifying the associated task, unique within the scope of the -process instance
-Readonly key
key: string
The key, a unique identifier for the job
-Readonly process
process
The version of the job process definition
-Readonly process
process
The job's process instance key
-Readonly retries
retries: number
Readonly type
type: string
The job type, as defined in the BPMN process (e.g. <zeebe:taskDefinition -type="payment-service" />)
-Readonly variables
All visible variables in the task scope, computed at activation time.
-Readonly worker
worker: string
The name of the worker that activated this job
-Generated using TypeDoc
Interface JobCompletionInterface<WorkerOutputVariables>
interface JobCompletionInterface<WorkerOutputVariables> {
cancelWorkflow: (() => Promise<"JOB_ACTION_ACKNOWLEDGEMENT">);
complete: ((updatedVariables?) => Promise<"JOB_ACTION_ACKNOWLEDGEMENT">);
error: ErrorJobOutcome;
fail: {
(errorMessage, retries?): Promise<JOB_ACTION_ACKNOWLEDGEMENT>;
(failureConfiguration): Promise<JOB_ACTION_ACKNOWLEDGEMENT>;
};
forward: (() => "JOB_ACTION_ACKNOWLEDGEMENT");
}
cancelWorkflow: (() => Promise<"JOB_ACTION_ACKNOWLEDGEMENT">);
complete: ((updatedVariables?) => Promise<"JOB_ACTION_ACKNOWLEDGEMENT">);
error: ErrorJobOutcome;
fail: {
(errorMessage, retries?): Promise<JOB_ACTION_ACKNOWLEDGEMENT>;
(failureConfiguration): Promise<JOB_ACTION_ACKNOWLEDGEMENT>;
};
forward: (() => "JOB_ACTION_ACKNOWLEDGEMENT");
}
Type Parameters
Hierarchy (view full)
- JobCompletionInterface
Index
Properties
Properties
cancel
cancel
Cancel the workflow.
-Type declaration
- (): Promise<"JOB_ACTION_ACKNOWLEDGEMENT">
Returns Promise<"JOB_ACTION_ACKNOWLEDGEMENT">
complete
complete: ((updatedVariables?) => Promise<"JOB_ACTION_ACKNOWLEDGEMENT">)
Complete the job with a success, optionally passing in a state update to merge -with the process variables on the broker.
-Type declaration
- (updatedVariables?): Promise<"JOB_ACTION_ACKNOWLEDGEMENT">
Parameters
OptionalupdatedVariables: WorkerOutputVariables
Returns Promise<"JOB_ACTION_ACKNOWLEDGEMENT">
error
Report a business error (i.e. non-technical) that occurs while processing a job. -The error is handled in the process by an error catch event. -If there is no error catch event with the specified errorCode then an incident will be raised instead.
-fail
fail: {
(errorMessage, retries?): Promise<JOB_ACTION_ACKNOWLEDGEMENT>;
(failureConfiguration): Promise<JOB_ACTION_ACKNOWLEDGEMENT>;
}
(errorMessage, retries?): Promise<JOB_ACTION_ACKNOWLEDGEMENT>;
(failureConfiguration): Promise<JOB_ACTION_ACKNOWLEDGEMENT>;
}
Fail the job with an informative message as to the cause. Optionally, pass in a
-value remaining retries. If no value is passed for retries then the current retry
-count is decremented. Pass in 0for retries to raise an incident in Operate. Optionally,
-specify a retry backoff period in milliseconds. Default is 0ms (immediate retry) if not
-specified.
Type declaration
- (errorMessage, retries?): Promise<JOB_ACTION_ACKNOWLEDGEMENT>
Parameters
- errorMessage: string
Optionalretries: number
Returns Promise<JOB_ACTION_ACKNOWLEDGEMENT>
- (failureConfiguration): Promise<JOB_ACTION_ACKNOWLEDGEMENT>
Parameters
- failureConfiguration: JobFailureConfiguration
Returns Promise<JOB_ACTION_ACKNOWLEDGEMENT>
forward
forward: (() => "JOB_ACTION_ACKNOWLEDGEMENT")
Mark this job as forwarded to another system for completion. No action is taken by the broker. -This method releases worker capacity to handle another job.
-Type declaration
- (): "JOB_ACTION_ACKNOWLEDGEMENT"
Returns "JOB_ACTION_ACKNOWLEDGEMENT"
Generated using TypeDoc
Interface JobFailureConfiguration
interface JobFailureConfiguration {
errorMessage: string;
retries?: number;
retryBackOff?: number;
}
errorMessage: string;
retries?: number;
retryBackOff?: number;
}
Index
Properties
Properties
error
error
Optional retries
retries?: number
If not specified, the library will decrement the "current remaining retries" count by one
-Optional retry
retry
Optional backoff for subsequent retries, in milliseconds. If not specified, it is zero.
-Generated using TypeDoc
Generated using TypeDoc
Interface MatchedDecisionRule
interface MatchedDecisionRule {
evaluatedOutputs: EvaluatedDecisionOutput[];
ruleId: string;
ruleIndex: number;
}
evaluatedOutputs: EvaluatedDecisionOutput[];
ruleId: string;
ruleIndex: number;
}
Index
Properties
Properties
evaluated
the evaluated decision outputs
-rule
rule
the id of the matched rule
-rule
rule
the index of the matched rule
-Generated using TypeDoc
Interface ModifyProcessInstanceRequest
interface ModifyProcessInstanceRequest {
activateInstructions?: ActivateInstruction[];
processInstanceKey: string;
terminateInstructions?: TerminateInstruction[];
}
activateInstructions?: ActivateInstruction[];
processInstanceKey: string;
terminateInstructions?: TerminateInstruction[];
}
Index
Properties
Properties
Optional activate
instructions describing which elements should be activated in which scopes, -and which variables should be created
-process
process
the key of the process instance that should be modified
-Optional terminate
instructions describing which elements should be terminated
-Generated using TypeDoc
Interface OAuthProviderConfig
interface OAuthProviderConfig {
audience: string;
authServerUrl: string;
cacheDir?: string;
cacheOnDisk?: boolean;
clientId: string;
clientSecret: string;
customRootCert?: Buffer;
}
audience: string;
authServerUrl: string;
cacheDir?: string;
cacheOnDisk?: boolean;
clientId: string;
clientSecret: string;
customRootCert?: Buffer;
}
Index
Properties
Properties
audience
audience: string
OAuth Audience
-auth
auth
OAuth Endpoint URL
-Optional cache
cache
Override default token cache directory
-Optional cache
cache
Cache token in memory and on filesystem?
-client
client
client
client
Optional custom
custom
Custom TLS certificate for OAuth
-Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Interface Partition
interface Partition {
health: PartitionBrokerHealth;
partitionId: number;
role: PartitionBrokerRole;
}
health: PartitionBrokerHealth;
partitionId: number;
role: PartitionBrokerRole;
}
Index
Properties
Properties
health
the health of this partition
-partition
partition
role
the role of the broker for this partition
-Generated using TypeDoc
Generated using TypeDoc
Interface ProcessInstanceCreationStartInstruction
Index
Properties
Properties
element
element
future extensions might include
--
-
- different types of start instructions -
- ability to set local variables for different flow scopes -for now, however, the start instruction is implicitly a -"startBeforeElement" instruction -
Generated using TypeDoc
Interface ProcessMetadata
interface ProcessMetadata {
bpmnProcessId: string;
processDefinitionKey: string;
resourceName: string;
tenantId: string;
version: number;
}
bpmnProcessId: string;
processDefinitionKey: string;
resourceName: string;
tenantId: string;
version: number;
}
Index
Properties
Properties
Readonly bpmn
bpmn
the bpmn process ID, as parsed during deployment; together with the version forms a -unique identifier for a specific process definition
-Readonly process
process
the assigned key, which acts as a unique identifier for this process
-Readonly resource
resource
the resource name (see: ProcessRequestObject.name) from which this process was -parsed
-tenant
tenant
the tenant identifier of the deployed process
-Readonly version
version: number
the assigned process version
-Generated using TypeDoc
Interface ProcessRequestObject
Index
Properties
definition
-name?
-
Properties
definition
definition: Buffer
Optional name
name?: string
Generated using TypeDoc
Interface PublishMessageRequest<Variables>
interface PublishMessageRequest<Variables> {
correlationKey: string;
messageId?: string;
name: string;
tenantId?: string;
timeToLive?: MaybeTimeDuration;
variables?: Variables;
}
correlationKey: string;
messageId?: string;
name: string;
tenantId?: string;
timeToLive?: MaybeTimeDuration;
variables?: Variables;
}
Type Parameters
- Variables = IInputVariables
Index
Properties
Properties
correlation
correlation
The value to match with the field specified as "Subscription Correlation Key" in BPMN
-Optional message
message
Unique ID for this message
-name
name: string
Should match the "Message Name" in a BPMN Message Catch
-Optional tenant
tenant
the tenantId of the message
-Optional time
time
The number of seconds for the message to buffer on the broker, awaiting correlation. Omit or set to zero for no buffering.
-Optional variables
Generated using TypeDoc
Generated using TypeDoc
Interface PublishStartMessageRequest<Variables>
interface PublishStartMessageRequest<Variables> {
correlationKey?: string;
messageId?: string;
name: string;
tenantId?: string;
timeToLive: MaybeTimeDuration;
variables: Variables;
}
correlationKey?: string;
messageId?: string;
name: string;
tenantId?: string;
timeToLive: MaybeTimeDuration;
variables: Variables;
}
Type Parameters
- Variables = IProcessVariables
Index
Properties
Properties
Optional correlation
correlation
Optional message
message
Unique ID for this message
-name
name: string
Should match the "Message Name" in a BPMN Message Catch
-Optional tenant
tenant
the tenantId for the message
-time
time
The number of seconds for the message to buffer on the broker, awaiting correlation. -Omit or set to zero for no buffering.
-variables
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Interface SetVariablesRequest<Variables>
interface SetVariablesRequest<Variables> {
elementInstanceKey: string;
local: boolean;
variables: Partial<Variables>;
}
elementInstanceKey: string;
local: boolean;
variables: Partial<Variables>;
}
Type Parameters
- Variables = IProcessVariables
Hierarchy (view full)
- SetVariablesRequestBase
- SetVariablesRequest
Index
Properties
Properties
Readonly element
element
local
local: boolean
if true, the variables will be merged strictly into the local scope (as indicated by
- elementInstanceKey); this means the variables is not propagated to upper scopes.
- for example, let's say we have two scopes, '1' and '2', with each having effective variables as:
-1 => { "foo" : 2 }, and 2 => { "bar" : 1 }. if we send an update request with
-elementInstanceKey = 2, variables { "foo" : 5 }, and local is true, then scope 1 will
-be unchanged, and scope 2 will now be { "bar" : 1, "foo" 5 }. if local was false, however,
-then scope 1 would be { "foo": 5 }, and scope 2 would be { "bar" : 1 }.
variables
Generated using TypeDoc
Interface SetVariablesRequestOnTheWire
interface SetVariablesRequestOnTheWire {
elementInstanceKey: string;
local: boolean;
variables: string;
}
elementInstanceKey: string;
local: boolean;
variables: string;
}
Hierarchy (view full)
- SetVariablesRequestBase
- SetVariablesRequestOnTheWire
Index
Properties
Properties
Readonly element
element
local
local: boolean
if true, the variables will be merged strictly into the local scope (as indicated by
- elementInstanceKey); this means the variables is not propagated to upper scopes.
- for example, let's say we have two scopes, '1' and '2', with each having effective variables as:
-1 => { "foo" : 2 }, and 2 => { "bar" : 1 }. if we send an update request with
-elementInstanceKey = 2, variables { "foo" : 5 }, and local is true, then scope 1 will
-be unchanged, and scope 2 will now be { "bar" : 1, "foo" 5 }. if local was false, however,
-then scope 1 would be { "foo": 5 }, and scope 2 would be { "bar" : 1 }.
variables
variables: string
Generated using TypeDoc
Interface StreamActivatedJobsRequest
interface StreamActivatedJobsRequest {
fetchVariable: string[];
tenantIds: string[];
timeout: number;
type: string;
worker: string;
}
fetchVariable: string[];
tenantIds: string[];
timeout: number;
type: string;
worker: string;
}
Index
Properties
Properties
fetch
fetch
a list of variables to fetch as the job variables; if empty, all visible variables at -the time of activation for the scope of the job will be returned
-tenant
tenant
a list of identifiers of tenants for which to stream jobs
-timeout
timeout: number
a job returned after this call will not be activated by another call until the -timeout (in ms) has been reached
-type
type: string
the job type, as defined in the BPMN process (e.g. <zeebe:taskDefinition type="payment-service" />)
-worker
worker: string
the name of the worker activating the jobs, mostly used for logging purposes
-Generated using TypeDoc
Generated using TypeDoc
Interface ThrowErrorRequest
interface ThrowErrorRequest {
errorCode: string;
errorMessage?: string;
jobKey: string;
variables?: JSONDoc;
}
errorCode: string;
errorMessage?: string;
jobKey: string;
variables?: JSONDoc;
}
Index
Properties
Properties
error
error
the error code that will be matched with an error catch event
-Optional error
error
an optional error message that provides additional context
-job
job
the unique job identifier, as obtained when activating the job
-Optional variables
JSON document that will instantiate the variables at the local scope of the error catch -event that catches the thrown error; it must be a JSON object, as variables will be mapped in a -key-value fashion. e.g. { "a": 1, "b": 2 } will create two variables, named "a" and -"b" respectively, with their associated values. [{ "a": 1, "b": 2 }] would not be a -valid argument, as the root of the JSON document is an array and not an object.
-Generated using TypeDoc
Interface TopologyResponse
interface TopologyResponse {
brokers: BrokerInfo[];
clusterSize: number;
gatewayVersion: string;
partitionsCount: number;
replicationFactor: number;
}
brokers: BrokerInfo[];
clusterSize: number;
gatewayVersion: string;
partitionsCount: number;
replicationFactor: number;
}
Index
Properties
Properties
Readonly brokers
Readonly cluster
cluster
Readonly gateway
gateway
Readonly partitions
partitions
Readonly replication
replication
Generated using TypeDoc
Generated using TypeDoc
Interface VariableInstruction
Properties
scope
scope
the id of the element in which scope the variables should be created; -leave empty to create the variables in the global scope of the process instance
-variables
JSON document that will instantiate the variables for the root variable scope of the -process instance; it must be a JSON object, as variables will be mapped in a -key-value fashion. e.g. { "a": 1, "b": 2 } will create two variables, named "a" and -"b" respectively, with their associated values. [{ "a": 1, "b": 2 }] would not be a -valid argument, as the root of the JSON document is an array and not an object.
-Generated using TypeDoc
Interface ZBClientOptions
interface ZBClientOptions {
camundaCloud?: CamundaCloudConfig;
connectionTolerance?: MaybeTimeDuration;
customSSL?: CustomSSL;
eagerConnection?: boolean;
hostname?: string;
logNamespace?: string;
loglevel?: Loglevel;
longPoll: MaybeTimeDuration;
maxRetries?: number;
maxRetryTimeout?: MaybeTimeDuration;
oAuth?: OAuthProviderConfig;
onConnectionError?: (() => void);
onReady?: (() => void);
pollInterval: MaybeTimeDuration;
port?: string;
retry?: boolean;
stdout?: ZBCustomLogger;
tenantId?: string;
useTLS?: boolean;
}
camundaCloud?: CamundaCloudConfig;
connectionTolerance?: MaybeTimeDuration;
customSSL?: CustomSSL;
eagerConnection?: boolean;
hostname?: string;
logNamespace?: string;
loglevel?: Loglevel;
longPoll: MaybeTimeDuration;
maxRetries?: number;
maxRetryTimeout?: MaybeTimeDuration;
oAuth?: OAuthProviderConfig;
onConnectionError?: (() => void);
onReady?: (() => void);
pollInterval: MaybeTimeDuration;
port?: string;
retry?: boolean;
stdout?: ZBCustomLogger;
tenantId?: string;
useTLS?: boolean;
}
Index
Properties
Optional camunda
Optional connection
connection
Optional customSSL
Optional eager
eager
Optional hostname
hostname?: string
Optional log
log
Optional loglevel
long
long
Optional max
max
Optional max
max
Optional o
Optional on
on
Type declaration
- (): void
Returns void
Optional on
on
Type declaration
- (): void
Returns void
poll
poll
Optional port
port?: string
Optional retry
retry?: boolean
Optional stdout
Optional tenant
tenant
Optional useTLS
useTLS?: boolean
Generated using TypeDoc
Interface ZBCustomLogger
interface ZBCustomLogger {
debug: ((message) => void);
error: ((message) => void);
info: ((message) => void);
}
debug: ((message) => void);
error: ((message) => void);
info: ((message) => void);
}
Properties
debug
debug: ((message) => void)
Receives a JSON-stringified ZBLogMessage
-Type declaration
- (message): void
Parameters
- message: string
Returns void
error
error: ((message) => void)
Receives a JSON-stringified ZBLogMessage
-Type declaration
- (message): void
Parameters
- message: string
Returns void
info
info: ((message) => void)
Receives a JSON-stringified ZBLogMessage
-Type declaration
- (message): void
Parameters
- message: string
Returns void
Generated using TypeDoc
Interface ZBGrpc
interface ZBGrpc {
activateJobsStream: ((req) => ClientReadableStream<unknown>);
channelClosed: boolean;
client: Client;
completeJobSync: ((req) => Promise<void>);
connected: boolean;
deleteResourceSync: ((deleteResourceRequest) => Promise<Record<string, never>>);
host: string;
longPoll?: MaybeTimeDuration;
broadcastSignalSync(signal): Promise<BroadcastSignalResponse>;
cancelProcessInstanceSync(processInstanceKey): Promise<void>;
close(timeout?): Promise<null>;
createProcessInstanceSync(createProcessInstanceRequest): Promise<CreateProcessInstanceResponse>;
createProcessInstanceWithResultSync(createProcessInstanceWithResultRequest): Promise<CreateProcessInstanceWithResultResponseOnWire>;
deployResourceSync<T>(resource): Promise<DeployResourceResponse<T>>;
evaluateDecisionSync(evaluateDecisionRequest): Promise<EvaluateDecisionResponse>;
failJobSync(failJobRequest): Promise<void>;
listMethods(): string[];
modifyProcessInstanceSync(request): Promise<ModifyProcessInstanceResponse>;
publishMessageSync(publishMessageRequest): Promise<PublishMessageResponse>;
resolveIncidentSync(resolveIncidentRequest): Promise<void>;
runService(fnName, data, fnAnswer): void;
setVariablesSync(request): Promise<void>;
throwErrorSync(throwErrorRequest): Promise<void>;
topologySync(): Promise<TopologyResponse>;
updateJobRetriesSync(updateJobRetriesRequest): Promise<void>;
}
activateJobsStream: ((req) => ClientReadableStream<unknown>);
channelClosed: boolean;
client: Client;
completeJobSync: ((req) => Promise<void>);
connected: boolean;
deleteResourceSync: ((deleteResourceRequest) => Promise<Record<string, never>>);
host: string;
longPoll?: MaybeTimeDuration;
broadcastSignalSync(signal): Promise<BroadcastSignalResponse>;
cancelProcessInstanceSync(processInstanceKey): Promise<void>;
close(timeout?): Promise<null>;
createProcessInstanceSync(createProcessInstanceRequest): Promise<CreateProcessInstanceResponse>;
createProcessInstanceWithResultSync(createProcessInstanceWithResultRequest): Promise<CreateProcessInstanceWithResultResponseOnWire>;
deployResourceSync<T>(resource): Promise<DeployResourceResponse<T>>;
evaluateDecisionSync(evaluateDecisionRequest): Promise<EvaluateDecisionResponse>;
failJobSync(failJobRequest): Promise<void>;
listMethods(): string[];
modifyProcessInstanceSync(request): Promise<ModifyProcessInstanceResponse>;
publishMessageSync(publishMessageRequest): Promise<PublishMessageResponse>;
resolveIncidentSync(resolveIncidentRequest): Promise<void>;
runService(fnName, data, fnAnswer): void;
setVariablesSync(request): Promise<void>;
throwErrorSync(throwErrorRequest): Promise<void>;
topologySync(): Promise<TopologyResponse>;
updateJobRetriesSync(updateJobRetriesRequest): Promise<void>;
}
Hierarchy (view full)
- GrpcClient
- ZBGrpc
Index
Properties
Methods
broadcast
Properties
activate
activate
Type declaration
- (req): ClientReadableStream<unknown>
Parameters
- req: ActivateJobsRequest
Returns ClientReadableStream<unknown>
channel
channel
client
client: Client
complete
complete
Type declaration
- (req): Promise<void>
Parameters
Returns Promise<void>
connected
connected: boolean = false
delete
delete
Type declaration
- (deleteResourceRequest): Promise<Record<string, never>>
Parameters
- deleteResourceRequest: DeleteResourceRequest
Returns Promise<Record<string, never>>
host
host: string
Optional long
long
Methods
broadcast
- broadcast
Signal Sync(signal): Promise<BroadcastSignalResponse> Parameters
- signal: BroadcastSignalRequest
Returns Promise<BroadcastSignalResponse>
cancel
close
create
- create
Process Instance Sync(createProcessInstanceRequest): Promise<CreateProcessInstanceResponse> Parameters
- createProcessInstanceRequest: CreateProcessInstanceRequest
Returns Promise<CreateProcessInstanceResponse>
create
- create
Process Instance With Result Sync(createProcessInstanceWithResultRequest): Promise<CreateProcessInstanceWithResultResponseOnWire> Parameters
- createProcessInstanceWithResultRequest: CreateProcessInstanceWithResultRequest
Returns Promise<CreateProcessInstanceWithResultResponseOnWire>
deploy
- deploy
Resource Sync<T>(resource): Promise<DeployResourceResponse<T>> Type Parameters
Parameters
- resource: DeployResourceRequest
Returns Promise<DeployResourceResponse<T>>
evaluate
- evaluate
Decision Sync(evaluateDecisionRequest): Promise<EvaluateDecisionResponse> Parameters
- evaluateDecisionRequest: EvaluateDecisionRequest
Returns Promise<EvaluateDecisionResponse>
fail
- fail
Job Sync(failJobRequest): Promise<void> Parameters
- failJobRequest: FailJobRequest
Returns Promise<void>
list
modify
- modify
Process Instance Sync(request): Promise<ModifyProcessInstanceResponse> Parameters
- request: ModifyProcessInstanceRequest
Returns Promise<ModifyProcessInstanceResponse>
publish
- publish
Message Sync(publishMessageRequest): Promise<PublishMessageResponse> Parameters
- publishMessageRequest: PublishMessageRequest<IInputVariables>
Returns Promise<PublishMessageResponse>
resolve
- resolve
Incident Sync(resolveIncidentRequest): Promise<void> Parameters
- resolveIncidentRequest: ResolveIncidentRequest
Returns Promise<void>
run
set
- set
Variables Sync(request): Promise<void> Parameters
- request: SetVariablesRequestOnTheWire
Returns Promise<void>
throw
- throw
Error Sync(throwErrorRequest): Promise<void> Parameters
- throwErrorRequest: ThrowErrorRequest
Returns Promise<void>
topology
- topology
Sync(): Promise<TopologyResponse> Returns Promise<TopologyResponse>
update
- update
Job Retries Sync(updateJobRetriesRequest): Promise<void> Parameters
- updateJobRetriesRequest: UpdateJobRetriesRequest
Returns Promise<void>
Generated using TypeDoc
Generated using TypeDoc
Interface ZBLoggerConfig
interface ZBLoggerConfig {
_tag: "ZBCLIENT" | "ZBWORKER";
color?: Chalk;
colorise?: boolean;
id?: string;
loglevel?: Loglevel;
longPoll?: MaybeTimeDuration;
namespace: string | string[];
pollInterval?: MaybeTimeDuration;
stdout?: ZBCustomLogger;
taskType?: string;
}
_tag: "ZBCLIENT" | "ZBWORKER";
color?: Chalk;
colorise?: boolean;
id?: string;
loglevel?: Loglevel;
longPoll?: MaybeTimeDuration;
namespace: string | string[];
pollInterval?: MaybeTimeDuration;
stdout?: ZBCustomLogger;
taskType?: string;
}
Hierarchy (view full)
- ZBLoggerOptions
- ZBLoggerConfig
Properties
_tag
_tag: "ZBCLIENT" | "ZBWORKER"
Optional color
color?: Chalk
Optional colorise
colorise?: boolean
Optional id
id?: string
Optional loglevel
Optional long
long
namespace
namespace: string | string[]
Optional poll
poll
Optional stdout
Optional task
task
Generated using TypeDoc
Interface ZBLoggerOptions
interface ZBLoggerOptions {
color?: Chalk;
loglevel?: Loglevel;
longPoll?: MaybeTimeDuration;
namespace: string | string[];
pollInterval?: MaybeTimeDuration;
stdout?: ZBCustomLogger;
taskType?: string;
}
color?: Chalk;
loglevel?: Loglevel;
longPoll?: MaybeTimeDuration;
namespace: string | string[];
pollInterval?: MaybeTimeDuration;
stdout?: ZBCustomLogger;
taskType?: string;
}
Hierarchy (view full)
- ZBLoggerOptions
Properties
Optional color
color?: Chalk
Optional loglevel
Optional long
long
namespace
namespace: string | string[]
Optional poll
poll
Optional stdout
Optional task
task
Generated using TypeDoc
Interface ZBWorkerConfig<WorkerInputVariables, CustomHeaderShape, WorkerOutputVariables>
interface ZBWorkerConfig<WorkerInputVariables, CustomHeaderShape, WorkerOutputVariables> {
connectionTolerance?: MaybeTimeDuration;
customHeadersDto?: (new (...args) => Readonly<CustomHeaderShape>);
debug?: boolean;
failProcessOnException?: boolean;
fetchVariable?: (keyof WorkerInputVariables)[];
id?: string;
inputVariableDto?: (new (...args) => Readonly<WorkerInputVariables>);
logNamespace?: string;
loglevel?: Loglevel;
longPoll?: MaybeTimeDuration;
maxJobsToActivate?: number;
onConnectionError?: (() => void);
onConnectionErrorHandler?: ConnectionErrorHandler;
onReady?: (() => void);
pollInterval?: MaybeTimeDuration;
stdout?: ZBCustomLogger;
taskHandler: ZBWorkerTaskHandler<WorkerInputVariables, CustomHeaderShape, WorkerOutputVariables>;
taskType: string;
timeout?: MaybeTimeDuration;
}
connectionTolerance?: MaybeTimeDuration;
customHeadersDto?: (new (...args) => Readonly<CustomHeaderShape>);
debug?: boolean;
failProcessOnException?: boolean;
fetchVariable?: (keyof WorkerInputVariables)[];
id?: string;
inputVariableDto?: (new (...args) => Readonly<WorkerInputVariables>);
logNamespace?: string;
loglevel?: Loglevel;
longPoll?: MaybeTimeDuration;
maxJobsToActivate?: number;
onConnectionError?: (() => void);
onConnectionErrorHandler?: ConnectionErrorHandler;
onReady?: (() => void);
pollInterval?: MaybeTimeDuration;
stdout?: ZBCustomLogger;
taskHandler: ZBWorkerTaskHandler<WorkerInputVariables, CustomHeaderShape, WorkerOutputVariables>;
taskType: string;
timeout?: MaybeTimeDuration;
}
Type Parameters
Hierarchy (view full)
- ZBWorkerOptions<WorkerInputVariables>
- ZBWorkerConfig
Index
Properties
Optional connection
connection
If your Grpc connection jitters, this is the window before the connectionError
-Optional custom
Provide an annotated Dto class to control the serialisation of JSON numbers. This allows you to serialise -numbers as strings or BigInts to avoid precision loss. This also gives you design-time type safety.
-Type declaration
- new (...args): Readonly<CustomHeaderShape>
Parameters
Rest...args: any[]
Returns Readonly<CustomHeaderShape>
Optional debug
debug?: boolean
Enable debug tracking
-Optional fail
fail
If a handler throws an unhandled exception, if this is set true, the process will be failed. Defaults to false.
-Optional fetch
Constrain payload to these keys only.
-Optional id
id?: string
A custom id for the worker. If none is supplied, a UUID will be generated.
-Optional input
Provide an annotated Dto class to control the serialisation of JSON numbers. This allows you to serialise -numbers as strings or BigInts to avoid precision loss. This also gives you design-time type safety.
-Type declaration
- new (...args): Readonly<WorkerInputVariables>
Parameters
Rest...args: any[]
Returns Readonly<WorkerInputVariables>
Optional log
log
Optional loglevel
A log level if you want it to differ from the ZBClient
-Optional long
long
A custom longpoll timeout. By default long polling is every 30 seconds.
-Optional max
max
Max concurrent tasks for this worker. Default 32.
-Optional on
on
This handler is called when the worker cannot connect to the broker, or loses its connection.
-Type declaration
- (): void
Returns void
Optional on
This handler is called when the worker cannot connect to the broker, or loses its connection.
-Optional on
on
This handler is called when the worker (re)establishes its connection to the broker
-Type declaration
- (): void
Returns void
Optional poll
poll
Poll Interval in ms. Default 100.
-Optional stdout
An implementation of the ZBCustomLogger interface for logging
-task
A job handler - this must return a job action - e.g.: job.complete(), job.error() - in all code paths.
-task
task
The task type that this worker will request jobs for.
-Optional timeout
timeout?: MaybeTimeDuration
Max seconds to allow before time out of a job given to this worker. Default: 30s. -The broker checks deadline timeouts every 30 seconds, so an
-Generated using TypeDoc
Interface ZBWorkerOptions<InputVars>
interface ZBWorkerOptions<InputVars> {
debug?: boolean;
failProcessOnException?: boolean;
fetchVariable?: (keyof InputVars)[];
maxJobsToActivate?: number;
onConnectionErrorHandler?: ConnectionErrorHandler;
pollInterval?: MaybeTimeDuration;
timeout?: MaybeTimeDuration;
}
debug?: boolean;
failProcessOnException?: boolean;
fetchVariable?: (keyof InputVars)[];
maxJobsToActivate?: number;
onConnectionErrorHandler?: ConnectionErrorHandler;
pollInterval?: MaybeTimeDuration;
timeout?: MaybeTimeDuration;
}
Type Parameters
- InputVars = IInputVariables
Hierarchy (view full)
- ZBWorkerOptions
Index
Properties
Optional debug
debug?: boolean
Enable debug tracking
-Optional fail
fail
If a handler throws an unhandled exception, if this is set true, the process will be failed. Defaults to false.
-Optional fetch
Constrain payload to these keys only.
-Optional max
max
Max concurrent tasks for this worker. Default 32.
-Optional on
This handler is called when the worker cannot connect to the broker, or loses its connection.
-Optional poll
poll
Poll Interval in ms. Default 100.
-Optional timeout
timeout?: MaybeTimeDuration
Max seconds to allow before time out of a job given to this worker. Default: 30s. -The broker checks deadline timeouts every 30 seconds, so an
-Generated using TypeDoc
Interface ZeebeJob<WorkerInputVariables, CustomHeaderShape, WorkerOutputVariables>
interface ZeebeJob<WorkerInputVariables, CustomHeaderShape, WorkerOutputVariables> {
bpmnProcessId: string;
cancelWorkflow: (() => Promise<"JOB_ACTION_ACKNOWLEDGEMENT">);
complete: ((updatedVariables?) => Promise<"JOB_ACTION_ACKNOWLEDGEMENT">);
customHeaders: Readonly<CustomHeaderShape>;
deadline: string;
elementId: string;
elementInstanceKey: string;
error: ErrorJobOutcome;
fail: {
(errorMessage, retries?): Promise<JOB_ACTION_ACKNOWLEDGEMENT>;
(failureConfiguration): Promise<JOB_ACTION_ACKNOWLEDGEMENT>;
};
forward: (() => "JOB_ACTION_ACKNOWLEDGEMENT");
key: string;
processDefinitionVersion: number;
processInstanceKey: string;
retries: number;
type: string;
variables: Readonly<WorkerInputVariables>;
worker: string;
}
bpmnProcessId: string;
cancelWorkflow: (() => Promise<"JOB_ACTION_ACKNOWLEDGEMENT">);
complete: ((updatedVariables?) => Promise<"JOB_ACTION_ACKNOWLEDGEMENT">);
customHeaders: Readonly<CustomHeaderShape>;
deadline: string;
elementId: string;
elementInstanceKey: string;
error: ErrorJobOutcome;
fail: {
(errorMessage, retries?): Promise<JOB_ACTION_ACKNOWLEDGEMENT>;
(failureConfiguration): Promise<JOB_ACTION_ACKNOWLEDGEMENT>;
};
forward: (() => "JOB_ACTION_ACKNOWLEDGEMENT");
key: string;
processDefinitionVersion: number;
processInstanceKey: string;
retries: number;
type: string;
variables: Readonly<WorkerInputVariables>;
worker: string;
}
Type Parameters
- WorkerInputVariables = IInputVariables
- CustomHeaderShape = ICustomHeaders
- WorkerOutputVariables = IOutputVariables
Hierarchy (view full)
Index
Properties
Properties
Readonly bpmn
bpmn
The bpmn process ID of the job process definition
-cancel
cancel
Cancel the workflow.
-Type declaration
- (): Promise<"JOB_ACTION_ACKNOWLEDGEMENT">
Returns Promise<"JOB_ACTION_ACKNOWLEDGEMENT">
complete
complete: ((updatedVariables?) => Promise<"JOB_ACTION_ACKNOWLEDGEMENT">)
Complete the job with a success, optionally passing in a state update to merge -with the process variables on the broker.
-Type declaration
- (updatedVariables?): Promise<"JOB_ACTION_ACKNOWLEDGEMENT">
Parameters
OptionalupdatedVariables: WorkerOutputVariables
Returns Promise<"JOB_ACTION_ACKNOWLEDGEMENT">
Readonly custom
A set of custom headers defined during modelling
-Readonly deadline
deadline: string
Readonly element
element
The associated task element ID
-Readonly element
element
The unique key identifying the associated task, unique within the scope of the -process instance
-error
Report a business error (i.e. non-technical) that occurs while processing a job. -The error is handled in the process by an error catch event. -If there is no error catch event with the specified errorCode then an incident will be raised instead.
-fail
fail: {
(errorMessage, retries?): Promise<JOB_ACTION_ACKNOWLEDGEMENT>;
(failureConfiguration): Promise<JOB_ACTION_ACKNOWLEDGEMENT>;
}
(errorMessage, retries?): Promise<JOB_ACTION_ACKNOWLEDGEMENT>;
(failureConfiguration): Promise<JOB_ACTION_ACKNOWLEDGEMENT>;
}
Fail the job with an informative message as to the cause. Optionally, pass in a
-value remaining retries. If no value is passed for retries then the current retry
-count is decremented. Pass in 0for retries to raise an incident in Operate. Optionally,
-specify a retry backoff period in milliseconds. Default is 0ms (immediate retry) if not
-specified.
Type declaration
- (errorMessage, retries?): Promise<JOB_ACTION_ACKNOWLEDGEMENT>
Parameters
- errorMessage: string
Optionalretries: number
Returns Promise<JOB_ACTION_ACKNOWLEDGEMENT>
- (failureConfiguration): Promise<JOB_ACTION_ACKNOWLEDGEMENT>
Parameters
- failureConfiguration: JobFailureConfiguration
Returns Promise<JOB_ACTION_ACKNOWLEDGEMENT>
forward
forward: (() => "JOB_ACTION_ACKNOWLEDGEMENT")
Mark this job as forwarded to another system for completion. No action is taken by the broker. -This method releases worker capacity to handle another job.
-Type declaration
- (): "JOB_ACTION_ACKNOWLEDGEMENT"
Returns "JOB_ACTION_ACKNOWLEDGEMENT"
Readonly key
key: string
The key, a unique identifier for the job
-Readonly process
process
The version of the job process definition
-Readonly process
process
The job's process instance key
-Readonly retries
retries: number
Readonly type
type: string
The job type, as defined in the BPMN process (e.g. <zeebe:taskDefinition -type="payment-service" />)
-Readonly variables
All visible variables in the task scope, computed at activation time.
-Readonly worker
worker: string
The name of the worker that activated this job
-Generated using TypeDoc
Interface CreateProcessInstanceWithResultResponseBase
interface CreateProcessInstanceWithResultResponseBase {
bpmnProcessId: string;
processDefinitionKey: string;
processInstanceKey: string;
tenantId: string;
version: number;
}
bpmnProcessId: string;
processDefinitionKey: string;
processInstanceKey: string;
tenantId: string;
version: number;
}
Hierarchy (view full)
- CreateProcessInstanceWithResultResponseBase
Index
Properties
Properties
Readonly bpmn
bpmn
the BPMN process ID of the process definition which was used to create the process -instance
-Readonly process
process
the key of the process definition which was used to create the process instance
-Readonly process
process
the unique identifier of the created process instance; to be used wherever a request -needs a process instance key (e.g. CancelProcessInstanceRequest)
-Readonly tenant
tenant
the tenant identifier of the process definition
-Readonly version
version: number
the version of the process definition which was used to create the process instance
-Generated using TypeDoc
Interface CustomSSL
interface CustomSSL {
certChain?: Buffer;
privateKey?: Buffer;
rootCerts?: Buffer;
verifyOptions?: VerifyOptions;
}
certChain?: Buffer;
privateKey?: Buffer;
rootCerts?: Buffer;
verifyOptions?: VerifyOptions;
}
Index
Properties
Properties
Optional cert
cert
Optional private
private
Optional root
root
Optional verify
verify
Generated using TypeDoc
Interface GrpcClientCtor
interface GrpcClientCtor {
config: {
CAMUNDA_CONSOLE_BASE_URL: undefined | string;
CAMUNDA_CONSOLE_CLIENT_ID: undefined | string;
CAMUNDA_CONSOLE_CLIENT_SECRET: undefined | string;
CAMUNDA_CONSOLE_OAUTH_AUDIENCE: string;
CAMUNDA_CUSTOM_CERT_CHAIN_PATH: undefined | string;
CAMUNDA_CUSTOM_PRIVATE_KEY_PATH: undefined | string;
CAMUNDA_CUSTOM_ROOT_CERT_PATH: undefined | string;
CAMUNDA_CUSTOM_USER_AGENT_STRING: undefined | string;
CAMUNDA_MODELER_BASE_URL: string;
CAMUNDA_MODELER_OAUTH_AUDIENCE: undefined | string;
CAMUNDA_OAUTH_DISABLED: boolean;
CAMUNDA_OAUTH_TOKEN_REFRESH_THRESHOLD_MS: number;
CAMUNDA_OAUTH_URL: undefined | string;
CAMUNDA_OPERATE_BASE_URL: undefined | string;
CAMUNDA_OPERATE_OAUTH_AUDIENCE: string;
CAMUNDA_OPTIMIZE_BASE_URL: undefined | string;
CAMUNDA_OPTIMIZE_OAUTH_AUDIENCE: string;
CAMUNDA_SECURE_CONNECTION: boolean;
CAMUNDA_TASKLIST_BASE_URL: undefined | string;
CAMUNDA_TASKLIST_OAUTH_AUDIENCE: string;
CAMUNDA_TENANT_ID: undefined | string;
CAMUNDA_TOKEN_CACHE_DIR: undefined | string;
CAMUNDA_TOKEN_DISK_CACHE_DISABLE: boolean;
CAMUNDA_TOKEN_SCOPE: undefined | string;
CAMUNDA_ZEEBE_OAUTH_AUDIENCE: string;
ZEEBE_ADDRESS: string;
ZEEBE_CLIENT_ID: undefined | string;
ZEEBE_CLIENT_SECRET: undefined | string;
zeebeGrpcSettings: {
GRPC_HTTP2_MAX_PINGS_WITHOUT_DATA: number;
GRPC_HTTP2_MIN_PING_INTERVAL_WITHOUT_DATA_MS: number;
GRPC_HTTP2_MIN_TIME_BETWEEN_PINGS_MS: number;
GRPC_INITIAL_RECONNECT_BACKOFF_MS: string | number;
GRPC_KEEPALIVE_PERMIT_WITHOUT_CALLS: number;
GRPC_KEEPALIVE_TIMEOUT_MS: number;
GRPC_KEEPALIVE_TIME_MS: number;
GRPC_MAX_RECONNECT_BACKOFF_MS: string | number;
GRPC_MIN_RECONNECT_BACKOFF_MS: string | number;
ZEEBE_CLIENT_LOG_LEVEL: string;
ZEEBE_CLIENT_LOG_TYPE: string;
ZEEBE_GRPC_CLIENT_CONNECTION_TOLERANCE_MS: number;
ZEEBE_GRPC_CLIENT_EAGER_CONNECT: boolean;
ZEEBE_GRPC_CLIENT_INITIAL_CONNECTION_TOLERANCE_MS: undefined | number;
ZEEBE_GRPC_CLIENT_MAX_RETRIES: number;
ZEEBE_GRPC_CLIENT_MAX_RETRY_TIMEOUT_SECONDS: number;
ZEEBE_GRPC_CLIENT_RETRY: boolean;
ZEEBE_GRPC_WORKER_LONGPOLL_SECONDS: number;
ZEEBE_GRPC_WORKER_POLL_INTERVAL_MS: number;
};
};
connectionTolerance: MaybeTimeDuration;
customSSL?: CustomSSL;
host: string;
loglevel: Loglevel;
namespace: string;
oAuth?: IOAuthProvider;
options: IParseOptions & IConversionOptions & {} & GrpcClientExtendedOptions;
packageName: string;
protoPath: string;
service: string;
stdout: ZBCustomLogger;
tasktype?: string;
useTLS: boolean;
}
config: {
CAMUNDA_CONSOLE_BASE_URL: undefined | string;
CAMUNDA_CONSOLE_CLIENT_ID: undefined | string;
CAMUNDA_CONSOLE_CLIENT_SECRET: undefined | string;
CAMUNDA_CONSOLE_OAUTH_AUDIENCE: string;
CAMUNDA_CUSTOM_CERT_CHAIN_PATH: undefined | string;
CAMUNDA_CUSTOM_PRIVATE_KEY_PATH: undefined | string;
CAMUNDA_CUSTOM_ROOT_CERT_PATH: undefined | string;
CAMUNDA_CUSTOM_USER_AGENT_STRING: undefined | string;
CAMUNDA_MODELER_BASE_URL: string;
CAMUNDA_MODELER_OAUTH_AUDIENCE: undefined | string;
CAMUNDA_OAUTH_DISABLED: boolean;
CAMUNDA_OAUTH_TOKEN_REFRESH_THRESHOLD_MS: number;
CAMUNDA_OAUTH_URL: undefined | string;
CAMUNDA_OPERATE_BASE_URL: undefined | string;
CAMUNDA_OPERATE_OAUTH_AUDIENCE: string;
CAMUNDA_OPTIMIZE_BASE_URL: undefined | string;
CAMUNDA_OPTIMIZE_OAUTH_AUDIENCE: string;
CAMUNDA_SECURE_CONNECTION: boolean;
CAMUNDA_TASKLIST_BASE_URL: undefined | string;
CAMUNDA_TASKLIST_OAUTH_AUDIENCE: string;
CAMUNDA_TENANT_ID: undefined | string;
CAMUNDA_TOKEN_CACHE_DIR: undefined | string;
CAMUNDA_TOKEN_DISK_CACHE_DISABLE: boolean;
CAMUNDA_TOKEN_SCOPE: undefined | string;
CAMUNDA_ZEEBE_OAUTH_AUDIENCE: string;
ZEEBE_ADDRESS: string;
ZEEBE_CLIENT_ID: undefined | string;
ZEEBE_CLIENT_SECRET: undefined | string;
zeebeGrpcSettings: {
GRPC_HTTP2_MAX_PINGS_WITHOUT_DATA: number;
GRPC_HTTP2_MIN_PING_INTERVAL_WITHOUT_DATA_MS: number;
GRPC_HTTP2_MIN_TIME_BETWEEN_PINGS_MS: number;
GRPC_INITIAL_RECONNECT_BACKOFF_MS: string | number;
GRPC_KEEPALIVE_PERMIT_WITHOUT_CALLS: number;
GRPC_KEEPALIVE_TIMEOUT_MS: number;
GRPC_KEEPALIVE_TIME_MS: number;
GRPC_MAX_RECONNECT_BACKOFF_MS: string | number;
GRPC_MIN_RECONNECT_BACKOFF_MS: string | number;
ZEEBE_CLIENT_LOG_LEVEL: string;
ZEEBE_CLIENT_LOG_TYPE: string;
ZEEBE_GRPC_CLIENT_CONNECTION_TOLERANCE_MS: number;
ZEEBE_GRPC_CLIENT_EAGER_CONNECT: boolean;
ZEEBE_GRPC_CLIENT_INITIAL_CONNECTION_TOLERANCE_MS: undefined | number;
ZEEBE_GRPC_CLIENT_MAX_RETRIES: number;
ZEEBE_GRPC_CLIENT_MAX_RETRY_TIMEOUT_SECONDS: number;
ZEEBE_GRPC_CLIENT_RETRY: boolean;
ZEEBE_GRPC_WORKER_LONGPOLL_SECONDS: number;
ZEEBE_GRPC_WORKER_POLL_INTERVAL_MS: number;
};
};
connectionTolerance: MaybeTimeDuration;
customSSL?: CustomSSL;
host: string;
loglevel: Loglevel;
namespace: string;
oAuth?: IOAuthProvider;
options: IParseOptions & IConversionOptions & {} & GrpcClientExtendedOptions;
packageName: string;
protoPath: string;
service: string;
stdout: ZBCustomLogger;
tasktype?: string;
useTLS: boolean;
}
Index
Properties
Properties
config
config: {
CAMUNDA_CONSOLE_BASE_URL: undefined | string;
CAMUNDA_CONSOLE_CLIENT_ID: undefined | string;
CAMUNDA_CONSOLE_CLIENT_SECRET: undefined | string;
CAMUNDA_CONSOLE_OAUTH_AUDIENCE: string;
CAMUNDA_CUSTOM_CERT_CHAIN_PATH: undefined | string;
CAMUNDA_CUSTOM_PRIVATE_KEY_PATH: undefined | string;
CAMUNDA_CUSTOM_ROOT_CERT_PATH: undefined | string;
CAMUNDA_CUSTOM_USER_AGENT_STRING: undefined | string;
CAMUNDA_MODELER_BASE_URL: string;
CAMUNDA_MODELER_OAUTH_AUDIENCE: undefined | string;
CAMUNDA_OAUTH_DISABLED: boolean;
CAMUNDA_OAUTH_TOKEN_REFRESH_THRESHOLD_MS: number;
CAMUNDA_OAUTH_URL: undefined | string;
CAMUNDA_OPERATE_BASE_URL: undefined | string;
CAMUNDA_OPERATE_OAUTH_AUDIENCE: string;
CAMUNDA_OPTIMIZE_BASE_URL: undefined | string;
CAMUNDA_OPTIMIZE_OAUTH_AUDIENCE: string;
CAMUNDA_SECURE_CONNECTION: boolean;
CAMUNDA_TASKLIST_BASE_URL: undefined | string;
CAMUNDA_TASKLIST_OAUTH_AUDIENCE: string;
CAMUNDA_TENANT_ID: undefined | string;
CAMUNDA_TOKEN_CACHE_DIR: undefined | string;
CAMUNDA_TOKEN_DISK_CACHE_DISABLE: boolean;
CAMUNDA_TOKEN_SCOPE: undefined | string;
CAMUNDA_ZEEBE_OAUTH_AUDIENCE: string;
ZEEBE_ADDRESS: string;
ZEEBE_CLIENT_ID: undefined | string;
ZEEBE_CLIENT_SECRET: undefined | string;
zeebeGrpcSettings: {
GRPC_HTTP2_MAX_PINGS_WITHOUT_DATA: number;
GRPC_HTTP2_MIN_PING_INTERVAL_WITHOUT_DATA_MS: number;
GRPC_HTTP2_MIN_TIME_BETWEEN_PINGS_MS: number;
GRPC_INITIAL_RECONNECT_BACKOFF_MS: string | number;
GRPC_KEEPALIVE_PERMIT_WITHOUT_CALLS: number;
GRPC_KEEPALIVE_TIMEOUT_MS: number;
GRPC_KEEPALIVE_TIME_MS: number;
GRPC_MAX_RECONNECT_BACKOFF_MS: string | number;
GRPC_MIN_RECONNECT_BACKOFF_MS: string | number;
ZEEBE_CLIENT_LOG_LEVEL: string;
ZEEBE_CLIENT_LOG_TYPE: string;
ZEEBE_GRPC_CLIENT_CONNECTION_TOLERANCE_MS: number;
ZEEBE_GRPC_CLIENT_EAGER_CONNECT: boolean;
ZEEBE_GRPC_CLIENT_INITIAL_CONNECTION_TOLERANCE_MS: undefined | number;
ZEEBE_GRPC_CLIENT_MAX_RETRIES: number;
ZEEBE_GRPC_CLIENT_MAX_RETRY_TIMEOUT_SECONDS: number;
ZEEBE_GRPC_CLIENT_RETRY: boolean;
ZEEBE_GRPC_WORKER_LONGPOLL_SECONDS: number;
ZEEBE_GRPC_WORKER_POLL_INTERVAL_MS: number;
};
}
CAMUNDA_CONSOLE_BASE_URL: undefined | string;
CAMUNDA_CONSOLE_CLIENT_ID: undefined | string;
CAMUNDA_CONSOLE_CLIENT_SECRET: undefined | string;
CAMUNDA_CONSOLE_OAUTH_AUDIENCE: string;
CAMUNDA_CUSTOM_CERT_CHAIN_PATH: undefined | string;
CAMUNDA_CUSTOM_PRIVATE_KEY_PATH: undefined | string;
CAMUNDA_CUSTOM_ROOT_CERT_PATH: undefined | string;
CAMUNDA_CUSTOM_USER_AGENT_STRING: undefined | string;
CAMUNDA_MODELER_BASE_URL: string;
CAMUNDA_MODELER_OAUTH_AUDIENCE: undefined | string;
CAMUNDA_OAUTH_DISABLED: boolean;
CAMUNDA_OAUTH_TOKEN_REFRESH_THRESHOLD_MS: number;
CAMUNDA_OAUTH_URL: undefined | string;
CAMUNDA_OPERATE_BASE_URL: undefined | string;
CAMUNDA_OPERATE_OAUTH_AUDIENCE: string;
CAMUNDA_OPTIMIZE_BASE_URL: undefined | string;
CAMUNDA_OPTIMIZE_OAUTH_AUDIENCE: string;
CAMUNDA_SECURE_CONNECTION: boolean;
CAMUNDA_TASKLIST_BASE_URL: undefined | string;
CAMUNDA_TASKLIST_OAUTH_AUDIENCE: string;
CAMUNDA_TENANT_ID: undefined | string;
CAMUNDA_TOKEN_CACHE_DIR: undefined | string;
CAMUNDA_TOKEN_DISK_CACHE_DISABLE: boolean;
CAMUNDA_TOKEN_SCOPE: undefined | string;
CAMUNDA_ZEEBE_OAUTH_AUDIENCE: string;
ZEEBE_ADDRESS: string;
ZEEBE_CLIENT_ID: undefined | string;
ZEEBE_CLIENT_SECRET: undefined | string;
zeebeGrpcSettings: {
GRPC_HTTP2_MAX_PINGS_WITHOUT_DATA: number;
GRPC_HTTP2_MIN_PING_INTERVAL_WITHOUT_DATA_MS: number;
GRPC_HTTP2_MIN_TIME_BETWEEN_PINGS_MS: number;
GRPC_INITIAL_RECONNECT_BACKOFF_MS: string | number;
GRPC_KEEPALIVE_PERMIT_WITHOUT_CALLS: number;
GRPC_KEEPALIVE_TIMEOUT_MS: number;
GRPC_KEEPALIVE_TIME_MS: number;
GRPC_MAX_RECONNECT_BACKOFF_MS: string | number;
GRPC_MIN_RECONNECT_BACKOFF_MS: string | number;
ZEEBE_CLIENT_LOG_LEVEL: string;
ZEEBE_CLIENT_LOG_TYPE: string;
ZEEBE_GRPC_CLIENT_CONNECTION_TOLERANCE_MS: number;
ZEEBE_GRPC_CLIENT_EAGER_CONNECT: boolean;
ZEEBE_GRPC_CLIENT_INITIAL_CONNECTION_TOLERANCE_MS: undefined | number;
ZEEBE_GRPC_CLIENT_MAX_RETRIES: number;
ZEEBE_GRPC_CLIENT_MAX_RETRY_TIMEOUT_SECONDS: number;
ZEEBE_GRPC_CLIENT_RETRY: boolean;
ZEEBE_GRPC_WORKER_LONGPOLL_SECONDS: number;
ZEEBE_GRPC_WORKER_POLL_INTERVAL_MS: number;
};
}
Type declaration
CAMUNDA_
CONSOLE_ BASE_ URL: undefined | string The base url for the Admin Console API.
-CAMUNDA_
CONSOLE_ CLIENT_ ID: undefined | string Credentials for Admin Console and Modeler API
-CAMUNDA_
CONSOLE_ CLIENT_ SECRET: undefined | string Credentials for Admin Console and Modeler API
-CAMUNDA_
CONSOLE_ OAUTH_ AUDIENCE: string The audience parameter for an Admin Console OAuth token request. Defaults to api.cloud.camunda.io when connecting to Camunda SaaS, and '' otherwise
-CAMUNDA_
CUSTOM_ CERT_ CHAIN_ PATH: undefined | string When using custom or self-signed certificates, provide the path to the certificate chain
-CAMUNDA_
CUSTOM_ PRIVATE_ KEY_ PATH: undefined | string When using custom or self-signed certificates, provide the path to the private key
-CAMUNDA_
CUSTOM_ ROOT_ CERT_ PATH: undefined | string In an environment using self-signed certificates, provide the path to the root certificate
-CAMUNDA_
CUSTOM_ USER_ AGENT_ STRING: undefined | string Custom user agent
-CAMUNDA_
MODELER_ BASE_ URL: string The base url for the Modeler API. Defaults to Camunda Saas - https://modeler.cloud.camunda.io/api
-CAMUNDA_
MODELER_ OAUTH_ AUDIENCE: undefined | string The audience parameter for a Modeler OAuth token request. Defaults to api.cloud.camunda.io when connecting to Camunda SaaS, and '' otherwise
-CAMUNDA_
OAUTH_ DISABLED: boolean Set to true to disable OAuth completely
-CAMUNDA_
OAUTH_ TOKEN_ REFRESH_ THRESHOLD_ MS: number How soon in milliseconds before its expiration time a cached OAuth token should be considered expired. Defaults to 1000
-CAMUNDA_
OAUTH_ URL: undefined | string The OAuth token exchange endpoint url
-CAMUNDA_
OPERATE_ BASE_ URL: undefined | string The base url for the Operate API
-CAMUNDA_
OPERATE_ OAUTH_ AUDIENCE: string The audience parameter for an Operate OAuth token request. Defaults to operate.camunda.io
-CAMUNDA_
OPTIMIZE_ BASE_ URL: undefined | string The base url for the Optimize API
-CAMUNDA_
OPTIMIZE_ OAUTH_ AUDIENCE: string The audience parameter for an Optimize OAuth token request. Defaults to optimize.camunda.io
-CAMUNDA_
SECURE_ CONNECTION: boolean Control TLS for Zeebe Grpc. Defaults to true. Set to false when using an unsecured gateway
-CAMUNDA_
TASKLIST_ BASE_ URL: undefined | string The base url for the Tasklist API
-CAMUNDA_
TASKLIST_ OAUTH_ AUDIENCE: string The audience parameter for a Tasklist OAuth token request. Defaults to tasklist.camunda.io
-CAMUNDA_
TENANT_ ID: undefined | string The tenant id when multi-tenancy is enabled
-CAMUNDA_
TOKEN_ CACHE_ DIR: undefined | string The directory to cache OAuth tokens on-disk. Defaults to $HOME/.camunda
-CAMUNDA_
TOKEN_ DISK_ CACHE_ DISABLE: boolean Set to true to disable disk caching of OAuth tokens and use memory caching only
-CAMUNDA_
TOKEN_ SCOPE: undefined | string Optional scope parameter for OAuth (needed by some OIDC)
-CAMUNDA_
ZEEBE_ OAUTH_ AUDIENCE: string The audience parameter for a Zeebe OAuth token request. Defaults to zeebe.camunda.io
-ZEEBE_
ADDRESS: string The address for the Zeebe Gateway. Defaults to localhost:26500
-ZEEBE_
CLIENT_ ID: undefined | string This is the client ID for the client credentials
-ZEEBE_
CLIENT_ SECRET: undefined | string This is the client secret for the client credentials
-zeebe
Grpc Settings: {
GRPC_HTTP2_MAX_PINGS_WITHOUT_DATA: number;
GRPC_HTTP2_MIN_PING_INTERVAL_WITHOUT_DATA_MS: number;
GRPC_HTTP2_MIN_TIME_BETWEEN_PINGS_MS: number;
GRPC_INITIAL_RECONNECT_BACKOFF_MS: string | number;
GRPC_KEEPALIVE_PERMIT_WITHOUT_CALLS: number;
GRPC_KEEPALIVE_TIMEOUT_MS: number;
GRPC_KEEPALIVE_TIME_MS: number;
GRPC_MAX_RECONNECT_BACKOFF_MS: string | number;
GRPC_MIN_RECONNECT_BACKOFF_MS: string | number;
ZEEBE_CLIENT_LOG_LEVEL: string;
ZEEBE_CLIENT_LOG_TYPE: string;
ZEEBE_GRPC_CLIENT_CONNECTION_TOLERANCE_MS: number;
ZEEBE_GRPC_CLIENT_EAGER_CONNECT: boolean;
ZEEBE_GRPC_CLIENT_INITIAL_CONNECTION_TOLERANCE_MS: undefined | number;
ZEEBE_GRPC_CLIENT_MAX_RETRIES: number;
ZEEBE_GRPC_CLIENT_MAX_RETRY_TIMEOUT_SECONDS: number;
ZEEBE_GRPC_CLIENT_RETRY: boolean;
ZEEBE_GRPC_WORKER_LONGPOLL_SECONDS: number;
ZEEBE_GRPC_WORKER_POLL_INTERVAL_MS: number;
}GRPC_
HTTP2_ MAX_ PINGS_ WITHOUT_ DATA: number This channel argument controls the maximum number -of pings that can be sent when there is no other -data (data frame or header frame) to be sent. -GRPC Core will not continue sending pings if we -run over the limit. Setting it to 0 allows sending -pings without sending data.
-GRPC_
HTTP2_ MIN_ PING_ INTERVAL_ WITHOUT_ DATA_ MS: number Minimum allowed time between a server receiving -successive ping frames without sending any data -frame. Int valued, milliseconds. Default: 90000
-GRPC_
HTTP2_ MIN_ TIME_ BETWEEN_ PINGS_ MS: number Defaults to 90000.
-GRPC_
INITIAL_ RECONNECT_ BACKOFF_ MS: string | number The time between the first and second connection attempts, -in ms. Defaults to 1000.
-GRPC_
KEEPALIVE_ PERMIT_ WITHOUT_ CALLS: number This channel argument if set to 1 -(0 : false; 1 : true), allows keepalive pings -to be sent even if there are no calls in flight. -Defaults to 1.
-GRPC_
KEEPALIVE_ TIMEOUT_ MS: number After waiting for a duration of this time, if the keepalive ping sender does not receive the ping ack, it will close the -transport. Int valued, milliseconds. Defaults to 120000.
-GRPC_
KEEPALIVE_ TIME_ MS: number After a duration of this time the client/server pings its peer to see if the transport is still alive. -Int valued, milliseconds. Defaults to 360000.
-GRPC_
MAX_ RECONNECT_ BACKOFF_ MS: string | number The maximum time between subsequent connection attempts, -in ms. Defaults to 10000.
-GRPC_
MIN_ RECONNECT_ BACKOFF_ MS: string | number The minimum time between subsequent connection attempts, -in ms. Default is 1000ms, but this can cause an SSL Handshake failure. -This causes an intermittent failure in the Worker-LongPoll test when run -against Camunda Cloud. -Raised to 5000ms. -See: https://github.com/grpc/grpc/issues/8382#issuecomment-259482949
-ZEEBE_
CLIENT_ LOG_ LEVEL: string Log level of Zeebe Client and Workers - 'DEBUG' | 'INFO' | 'NONE'. Defaults to 'INFO'
-ZEEBE_
CLIENT_ LOG_ TYPE: string Zeebe client log output can be human-readable 'SIMPLE' or structured 'JSON'. Defaults to 'SIMPLE'
-ZEEBE_
GRPC_ CLIENT_ CONNECTION_ TOLERANCE_ MS: number The gRPC channel can "jitter". This suppresses a connection error message if the channel comes back within this window in milliseconds. Defaults to 3000
-ZEEBE_
GRPC_ CLIENT_ EAGER_ CONNECT: boolean Immediately connect to the Zeebe Gateway (issues a silent topology request). Defaults to false
-ZEEBE_
GRPC_ CLIENT_ INITIAL_ CONNECTION_ TOLERANCE_ MS: undefined | number This suppresses intermediate errors during initial connection negotiation. On Camunda SaaS this defaults to 6000, on Self-Managed to 0
-ZEEBE_
GRPC_ CLIENT_ MAX_ RETRIES: number Maximum number of retries of network operations before failing. Defaults to -1 (infinite retries)
-ZEEBE_
GRPC_ CLIENT_ MAX_ RETRY_ TIMEOUT_ SECONDS: number When retrying failed network operations, retries back off to this maximum period. Defaults to 10s
-ZEEBE_
GRPC_ CLIENT_ RETRY: boolean Automate retrying operations that fail due to network conditions or broker backpressure. Defaults to true
-ZEEBE_
GRPC_ WORKER_ LONGPOLL_ SECONDS: number How long in seconds the long poll Job Activation request is held open by a worker. Defaults to 60
-ZEEBE_
GRPC_ WORKER_ POLL_ INTERVAL_ MS: number After a long poll Job Activation request, this is the cool-off period in milliseconds before the worker requests more work. Defaults to 300
-
connection
connection
Optional customSSL
host
host: string
loglevel
namespace
namespace: string
Optional o
options
Type declaration
package
package
proto
proto
service
service: string
stdout
Optional tasktype
tasktype?: string
useTLS
useTLS: boolean
Generated using TypeDoc
Interface GrpcClientExtendedOptions
interface GrpcClientExtendedOptions {
longPoll?: MaybeTimeDuration;
pollInterval?: MaybeTimeDuration;
}
longPoll?: MaybeTimeDuration;
pollInterval?: MaybeTimeDuration;
}
Index
Properties
Properties
Optional long
long
Optional poll
poll
Generated using TypeDoc
Interface SetVariablesRequestBase
Hierarchy (view full)
- SetVariablesRequestBase
Index
Properties
Properties
Readonly element
element
local
local: boolean
if true, the variables will be merged strictly into the local scope (as indicated by
- elementInstanceKey); this means the variables is not propagated to upper scopes.
- for example, let's say we have two scopes, '1' and '2', with each having effective variables as:
-1 => { "foo" : 2 }, and 2 => { "bar" : 1 }. if we send an update request with
-elementInstanceKey = 2, variables { "foo" : 5 }, and local is true, then scope 1 will
-be unchanged, and scope 2 will now be { "bar" : 1, "foo" 5 }. if local was false, however,
-then scope 1 would be { "foo": 5 }, and scope 2 would be { "bar" : 1 }.
Generated using TypeDoc
Namespace AdminDto
Index
Interfaces
Type Aliases
Generated using TypeDoc
Namespace Admin
Index
Namespaces
Admin
Classes
Generated using TypeDoc
Namespace Auth
Index
Classes
Interfaces
Generated using TypeDoc
Namespace ModelerDto
Index
Interfaces
Create
Generated using TypeDoc
Namespace Modeler
Index
Namespaces
Classes
Generated using TypeDoc
Namespace OperateDto
Index
Classes
Interfaces
Generated using TypeDoc
Namespace Operate
Index
Namespaces
Classes
Generated using TypeDoc
Namespace OptimizeDto
Index
Interfaces
Type Aliases
Generated using TypeDoc
Namespace Optimize
Index
Namespaces
Classes
Generated using TypeDoc
Namespace TasklistDto
Index
Classes
Interfaces
Type Aliases
Generated using TypeDoc
Namespace Tasklist
Index
Namespaces
Classes
Generated using TypeDoc
Namespace Types
Index
Enumerations
Variables
Generated using TypeDoc
Generated using TypeDoc
Module <internal>
Index
Classes
Interfaces
Type Aliases
Variables
Generated using TypeDoc
Generated using TypeDoc
Module <internal>
Index
Classes
Interfaces
Generated using TypeDoc
Module zeebe/types
Index
References
Modules
Interfaces
Activate
Type Aliases
Variables
References
Partition
Re-exports PartitionBrokerHealthPartition
Re-exports PartitionBrokerRoleGenerated using TypeDoc
Type alias ClusterStatusstring
Cluster
Generated using TypeDoc
Type alias OrganizationRole
Organization
Generated using TypeDoc
Type alias DashboardCollection
Dashboard
id: string;
}[]
id: string;
}[]
Type declaration
id: string
Generated using TypeDoc
Type alias EntityImportResponse
Entity
entityType: "dashboard" | "report";
id: string;
}[]
entityType: "dashboard" | "report";
id: string;
}[]
Type declaration
entity
Type: "dashboard" | "report" id: string
Generated using TypeDoc
Type alias ReportCollection
Report
id: string;
}[]
id: string;
}[]
Type declaration
id: string
Generated using TypeDoc
Type alias SingleProcessReport
Single
Generated using TypeDoc
Type alias VariableType
Variable
Generated using TypeDoc
Type alias TaskState
Task
Generated using TypeDoc
Generated using TypeDoc
Type alias EnhanceWithTenantIdIfMissing<T>
Enhance
filter: {
tenantId: string | undefined;
};
}
? T
: T extends {
filter: infer F;
}
? {
filter: F & {
tenantId: string | undefined;
};
} & Omit<T, "filter">
: {
filter: {
tenantId: string | undefined;
};
} & T
filter: {
tenantId: string | undefined;
};
}
? T
: T extends {
filter: infer F;
}
? {
filter: F & {
tenantId: string | undefined;
};
} & Omit<T, "filter">
: {
filter: {
tenantId: string | undefined;
};
} & T
Type Parameters
Generated using TypeDoc
Generated using TypeDoc
Type alias EventMap
Event
Generated using TypeDoc
Type alias EventReceiver
Event
Type declaration
- (): void
Returns void
Generated using TypeDoc
Type alias GrpcConnectionProfile
Grpc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Type alias LogFn
Log
Type declaration
- (logMessage): void
Parameters
- logMessage: string
Returns void
Generated using TypeDoc
Type alias State
State: "ERROR" | "CONNECTED" | "UNKNOWN"
Generated using TypeDoc
Type alias TokenGrantAudienceType
Token
Generated using TypeDoc
Type alias ConnectionErrorHandler
Connection
Type declaration
- (error?): void
Parameters
Optionalerror: unknown
Returns void
Generated using TypeDoc
Type alias Deployment
Deployment: ProcessDeployment | DecisionDeployment | DecisionRequirementsDeployment | FormDeployment
Generated using TypeDoc
Type alias ErrorJobOutcome
Type declaration
- (errorCode, errorMessage?): Promise<JOB_ACTION_ACKNOWLEDGEMENT>
Parameters
- errorCode: string | ErrorJobWithVariables
OptionalerrorMessage: string
Returns Promise<JOB_ACTION_ACKNOWLEDGEMENT>
Generated using TypeDoc
Type alias EvaluateDecisionRequest
Evaluate
decisionKey: string;
tenantId?: string;
variables: JSONDoc;
} | {
decisionId: string;
tenantId?: string;
variables: JSONDoc;
}
decisionKey: string;
tenantId?: string;
variables: JSONDoc;
} | {
decisionId: string;
tenantId?: string;
variables: JSONDoc;
}
Type declaration
decision
Key: string the unique key identifying the decision to be evaluated (e.g. returned -from a decision in the DeployResourceResponse message)
-OptionaltenantId?: string the tenant identifier of the decision
-variables: JSONDoc
JSON document that will instantiate the variables for the decision to be -evaluated; it must be a JSON object, as variables will be mapped in a -key-value fashion, e.g. { "a": 1, "b": 2 } will create two variables, -named "a" and "b" respectively, with their associated values. -[{ "a": 1, "b": 2 }] would not be a valid argument, as the root of the -JSON document is an array and not an object.
-
Type declaration
decision
Id: string the ID of the decision to be evaluated
-OptionaltenantId?: string the tenant identifier of the decision
-variables: JSONDoc
JSON document that will instantiate the variables for the decision to be -evaluated; it must be a JSON object, as variables will be mapped in a -key-value fashion, e.g. { "a": 1, "b": 2 } will create two variables, -named "a" and "b" respectively, with their associated values. -[{ "a": 1, "b": 2 }] would not be a valid argument, as the root of the -JSON document is an array and not an object.
-
Generated using TypeDoc
Type alias JOB_ACTION_ACKNOWLEDGEMENT
Generated using TypeDoc
Generated using TypeDoc
Type alias Loglevel
Loglevel: "INFO" | "DEBUG" | "NONE" | "ERROR"
Generated using TypeDoc
Type alias ModifyProcessInstanceResponse
Modify
Generated using TypeDoc
Type alias MustReturnJobActionAcknowledgement
Must
Generated using TypeDoc
Type alias OperationOptions
Generated using TypeDoc
Type alias ZBWorkerTaskHandler<WorkerInputVariables, CustomHeaderShape, WorkerOutputVariables>
ZBWorker
Type Parameters
- WorkerInputVariables = IInputVariables
- CustomHeaderShape = ICustomHeaders
- WorkerOutputVariables = IOutputVariables
Type declaration
- (job, worker): MustReturnJobActionAcknowledgement
Parameters
- job: Readonly<ZeebeJob<WorkerInputVariables, CustomHeaderShape, WorkerOutputVariables>>
- worker: ZBWorker<WorkerInputVariables, CustomHeaderShape, WorkerOutputVariables>
Returns MustReturnJobActionAcknowledgement
Generated using TypeDoc
Variable DtoConst
Dto: {
BigIntValue: ((target, propertKey) => void);
ChildDto: ((childClass) => ((target, propertyKey) => void));
Int64String: ((target, propertyKey) => void);
LosslessDto: typeof LosslessDto;
} = ...
BigIntValue: ((target, propertKey) => void);
ChildDto: ((childClass) => ((target, propertyKey) => void));
Int64String: ((target, propertyKey) => void);
LosslessDto: typeof LosslessDto;
} = ...
Type declaration
Big
Int Value: ((target, propertKey) => void) - (target, propertKey): void
Decorate Dto bigint fields as
-@BigIntto specify that the JSON number property should be parsed as a bigint.Parameters
- target: any
- propertKey: string | symbol
Returns void
Example
-class MyDto extends LosslessDto {
@Int64String
int64NumberField!: string
@BigIntValue
bigintField!: bigint
@ChildDto(MyChildDto)
childDtoField!: MyChildDto
normalField!: string
normalNumberField!: number
maybePresentField?: string
} -
Child
Dto: ((childClass) => ((target, propertyKey) => void)) - (childClass): ((target, propertyKey) => void)
Decorate a Dto object field as
-@ChildDtoto specify that the JSON object property should be parsed as a child Dto.Parameters
- childClass: any
Returns ((target, propertyKey) => void)
- (target, propertyKey): void
Parameters
- target: any
- propertyKey: string | symbol
Returns void
Example
-
class MyChildDto extends LosslessDto {
someField!: string
}
class MyDto extends LosslessDto {
@Int64String
int64NumberField!: string
@BigIntValue
bigintField!: bigint
@ChildDto(MyChildDto)
childDtoField!: MyChildDto
normalField!: string
normalNumberField!: number
maybePresentField?: string
} -
Int64
String: ((target, propertyKey) => void) - (target, propertyKey): void
Decorate Dto string fields as
-@Int64Stringto specify that the JSON number property should be parsed as a string.Parameters
- target: any
- propertyKey: string | symbol
Returns void
Example
-class MyDto extends LosslessDto {
@Int64String
int64NumberField!: string
@BigIntValue
bigintField!: bigint
@ChildDto(MyChildDto)
childDtoField!: MyChildDto
normalField!: string
normalNumberField!: number
maybePresentField?: string
} -
Lossless
Dto: typeof LosslessDto
Generated using TypeDoc
Variable LoggingConst
Logging: {
ZBJsonLogger: {
debug: ((message?, ...optionalParams) => void);
error: ((message?, ...optionalParams) => void);
info: ((message?, ...optionalParams) => void);
};
ZBLogger: typeof ZBLogger;
ZBSimpleLogger: Logger;
} = ...
ZBJsonLogger: {
debug: ((message?, ...optionalParams) => void);
error: ((message?, ...optionalParams) => void);
info: ((message?, ...optionalParams) => void);
};
ZBLogger: typeof ZBLogger;
ZBSimpleLogger: Logger;
} = ...
Type declaration
ZBJson
Logger: {
debug: ((message?, ...optionalParams) => void);
error: ((message?, ...optionalParams) => void);
info: ((message?, ...optionalParams) => void);
}debug: ((message?, ...optionalParams) => void)
- (message?, ...optionalParams): void
Prints to
-stdoutwith newline. Multiple arguments can be passed, with the -first used as the primary message and all additional used as substitution -values similar toprintf(3)(the arguments are all passed toutil.format()).
-const count = 5;
console.log('count: %d', count);
// Prints: count: 5, to stdout
console.log('count:', count);
// Prints: count: 5, to stdout -See
-util.format()for more information.Parameters
Optionalmessage: anyRest...optionalParams: any[]
Returns void
Since
v0.1.100
-
error: ((message?, ...optionalParams) => void)
- (message?, ...optionalParams): void
Prints to
-stderrwith newline. Multiple arguments can be passed, with the -first used as the primary message and all additional used as substitution -values similar toprintf(3)(the arguments are all passed toutil.format()).
-const code = 5;
console.error('error #%d', code);
// Prints: error #5, to stderr
console.error('error', code);
// Prints: error 5, to stderr -If formatting elements (e.g.
-%d) are not found in the first string thenutil.inspect()is called on each argument and the resulting string -values are concatenated. Seeutil.format()for more information.Parameters
Optionalmessage: anyRest...optionalParams: any[]
Returns void
Since
v0.1.100
-
info: ((message?, ...optionalParams) => void)
- (message?, ...optionalParams): void
Prints to
-stdoutwith newline. Multiple arguments can be passed, with the -first used as the primary message and all additional used as substitution -values similar toprintf(3)(the arguments are all passed toutil.format()).
-const count = 5;
console.log('count: %d', count);
// Prints: count: 5, to stdout
console.log('count:', count);
// Prints: count: 5, to stdout -See
-util.format()for more information.Parameters
Optionalmessage: anyRest...optionalParams: any[]
Returns void
Since
v0.1.100
-
ZBLogger: typeof ZBLogger
ZBSimple
Logger: Logger
Generated using TypeDoc
Variable JOB_ACTION_ACKNOWLEDGEMENT
JOB_
Generated using TypeDoc
Variable ConnectionStatusEventConst
Connection
close: "close";
connectionError: "connectionError";
ready: "ready";
unknown: "unknown";
} = ...
close: "close";
connectionError: "connectionError";
ready: "ready";
unknown: "unknown";
} = ...
Type declaration
close: "close"
connection
Error: "connectionError" ready: "ready"
unknown: "unknown"
Generated using TypeDoc
Variable JOB_ACTION_ACKNOWLEDGEMENTConst
JOB_
Generated using TypeDoc
Description
Create a new API client for a cluster. See the API Documentation for more details.
-